service/cache_snapshot

Api Code Documentation / Exports / service/cache_snapshot

Table of contents

Functions

• getLatestSnapshot
• parseBusinessEvents
• publishSnapshot

Functions

getLatestSnapshot

▸ getLatestSnapshot(ctx, conn, streamName, key, eventType): Promise<Type<Project>>

Parameters

Name	Type
ctx	Ctx
conn	ConnToken
streamName	string
key	string
eventType	"project_snapshot_published"

Returns

Promise<Type<Project>>

Defined in

src/service/cache_snapshot.ts:80

▸ getLatestSnapshot(ctx, conn, streamName, key, eventType): Promise<Type<Subproject>>

Parameters

Name	Type
ctx	Ctx
conn	ConnToken
streamName	string
key	string
eventType	"subproject_snapshot_published"

Returns

Promise<Type<Subproject>>

Defined in

src/service/cache_snapshot.ts:88

▸ getLatestSnapshot(ctx, conn, streamName, key, eventType): Promise<Type<Workflowitem>>

Parameters

Name	Type
ctx	Ctx
conn	ConnToken
streamName	string
key	string
eventType	"workflowitem_snapshot_published"

Returns

Promise<Type<Workflowitem>>

Defined in

src/service/cache_snapshot.ts:96

---

parseBusinessEvents

▸ parseBusinessEvents(items, streamName): Type<BusinessEvent>[]

Parameters

Name	Type
items	Item[]
streamName	string

Returns

Type<BusinessEvent>[]

Defined in

src/service/cache_snapshot.ts:338

---

publishSnapshot

▸ publishSnapshot(ctx, conn, streamName, key, eventType, creatingUser, createEvent, ordering?): Promise<{ canPublish: boolean ; eventData: Type<BusinessEvent> }>

Parameters

Name	Type
ctx	Ctx
conn	ConnToken
streamName	string
key	string
eventType	string
creatingUser	ServiceUser
createEvent	Function
ordering?	WorkflowitemOrdering

Returns

Promise<{ canPublish: boolean ; eventData: Type<BusinessEvent> }>

Defined in

src/service/cache_snapshot.ts:190