cap-nodejs

CAP Node.js API

CAP Node.js API / cap-core/src / PublishStoragePort

Interface: PublishStoragePort<TTx>

Defined in: cap-core/src/ports/publish-storage.port.ts:37

Extended by

Type Parameters

TTx

TTx = unknown

Methods

claimUnpublished()

claimUnpublished(options): Promise<CapPublishEvent<JsonValue>[]>

Defined in: cap-core/src/ports/publish-storage.port.ts:45

Parameters

options

ClaimUnpublishedOptions

Returns

Promise<CapPublishEvent<JsonValue>[]>

findPublishById()?

optional findPublishById(id): Promise<CapPublishEvent<JsonValue> | undefined>

Defined in: cap-core/src/ports/publish-storage.port.ts:65

Parameters

id

string

Returns

Promise<CapPublishEvent<JsonValue> | undefined>

initialize()?

optional initialize(options?): Promise<void>

Defined in: cap-core/src/ports/publish-storage.port.ts:43

Parameters

options?

InitOptions

Returns

Promise<void>

listPublish()?

optional listPublish(options): Promise<DashboardListResult<CapPublishEvent<JsonValue>>>

Defined in: cap-core/src/ports/publish-storage.port.ts:67

Parameters

options

DashboardListOptions

Returns

Promise<DashboardListResult<CapPublishEvent<JsonValue>>>

markPublished()

markPublished(id, publishedAt?, ownership?): Promise<boolean | void>

Defined in: cap-core/src/ports/publish-storage.port.ts:49

Parameters

id

string

publishedAt?

Date

ownership?

PublishClaimOwnership

Returns

Promise<boolean | void>

markPublishFailed()

markPublishFailed(id, error, options): Promise<boolean | void>

Defined in: cap-core/src/ports/publish-storage.port.ts:55

Parameters

id

string

error

unknown

options

MarkPublishFailedOptions

Returns

Promise<boolean | void>

releaseExpiredClaims()

releaseExpiredClaims(now): Promise<void>

Defined in: cap-core/src/ports/publish-storage.port.ts:63

Parameters

now

Date

Returns

Promise<void>

renewPublishClaim()?

optional renewPublishClaim(options): Promise<boolean>

Defined in: cap-core/src/ports/publish-storage.port.ts:61

Parameters

options

RenewPublishClaimOptions

Returns

Promise<boolean>

savePublish()

savePublish<T>(event, ctx?): Promise<string>

Defined in: cap-core/src/ports/publish-storage.port.ts:38

Type Parameters

T

T extends JsonValue = JsonValue

Parameters

event

CapPublishEvent<T>

ctx?

CapOperationContext<TTx>

Returns

Promise<string>

This site is open source. Improve this page.