cap-nodejs

CAP Node.js API

---

CAP Node.js API / cap-storage-mikro-orm/src / MikroPublishStorage

Class: MikroPublishStorage

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:45

Implements

• PublishStoragePort<EntityManager>
• CapabilityAwareStoragePort

Constructors

Constructor

new MikroPublishStorage(em, orm?, logger?): MikroPublishStorage

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:48

Parameters

em

EntityManager

orm?

MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

logger?

CapLogger

Returns

MikroPublishStorage

Methods

claimUnpublished()

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

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:104

Parameters

options

ClaimUnpublishedOptions

Returns

Promise<CapPublishEvent<JsonValue>[]>

Implementation of

PublishStoragePort.claimUnpublished

---

findPublishById()

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

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:194

Parameters

id

string

Returns

Promise<CapPublishEvent<JsonValue> | undefined>

Implementation of

PublishStoragePort.findPublishById

---

getCapabilities()

getCapabilities(): CapStorageCapabilities

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:100

Returns

CapStorageCapabilities

Implementation of

CapabilityAwareStoragePort.getCapabilities

---

initialize()?

optional initialize(options?): Promise<void>

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:54

Parameters

options?

autoInit?

boolean

createSchema?

boolean

Returns

Promise<void>

Implementation of

PublishStoragePort.initialize

---

listPublish()

listPublish(opts): Promise<{ items: CapPublishEvent<JsonValue>[]; total: number; }>

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:205

Parameters

opts

limit?

number

offset?

number

onlyUnpublished?

boolean

topic?

string

Returns

Promise<{ items: CapPublishEvent<JsonValue>[]; total: number; }>

Implementation of

PublishStoragePort.listPublish

---

markPublished()

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

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:126

Parameters

id

string

publishedAt?

Date = ...

ownership?

PublishClaimOwnership = {}

Returns

Promise<boolean>

Implementation of

PublishStoragePort.markPublished

---

markPublishFailed()

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

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:143

Parameters

id

string

error

unknown

options

MarkPublishFailedOptions

Returns

Promise<boolean>

Implementation of

PublishStoragePort.markPublishFailed

---

releaseExpiredClaims()

releaseExpiredClaims(now): Promise<void>

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:186

Parameters

now

Date

Returns

Promise<void>

Implementation of

PublishStoragePort.releaseExpiredClaims

---

renewPublishClaim()

renewPublishClaim(options): Promise<boolean>

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:172

Parameters

options

RenewPublishClaimOptions

Returns

Promise<boolean>

Implementation of

PublishStoragePort.renewPublishClaim

---

savePublish()

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

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:80

Parameters

event

CapPublishEvent<JsonValue>

ctx?

CapOperationContext<EntityManager<IDatabaseDriver<Connection>>>

Returns

Promise<string>

Implementation of

PublishStoragePort.savePublish

---

savePublishWithTx()

savePublishWithTx(event, tx): Promise<string>

Defined in: cap-storage-mikro-orm/src/storage/mikro-publish-storage.ts:93

Parameters

event

CapPublishEvent<JsonValue>

tx

EntityManager

Returns

Promise<string>

Deprecated

Use savePublish(event, { tx }) instead.

This site is open source. Improve this page.