cap-nodejs

CAP Node.js API


CAP Node.js API / cap-storage-prisma/src / PrismaPublishStorage

Class: PrismaPublishStorage

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:71

Implements

Constructors

Constructor

new PrismaPublishStorage(client, options): PrismaPublishStorage

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:78

Parameters

client

PrismaCapClient

options

PrismaStorageOptions

Returns

PrismaPublishStorage

Methods

claimUnpublished()

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

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:119

Parameters

options

ClaimUnpublishedOptions

Returns

Promise<CapPublishEvent<JsonValue>[]>

Implementation of

PublishStoragePort.claimUnpublished


findPublishById()

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

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:312

Parameters

id

string

Returns

Promise<CapPublishEvent<JsonValue> | undefined>

Implementation of

PublishStoragePort.findPublishById


getCapabilities()

getCapabilities(): CapStorageCapabilities

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:115

Returns

CapStorageCapabilities

Implementation of

CapabilityAwareStoragePort.getCapabilities


initialize()

initialize(options?): Promise<void>

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:85

Parameters

options?

InitOptions

Returns

Promise<void>

Implementation of

PublishStoragePort.initialize


listPublish()

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

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:319

Parameters

options?

DashboardListOptions = {}

Returns

Promise<DashboardListResult<CapPublishEvent<JsonValue>>>

Implementation of

PublishStoragePort.listPublish


markPublished()

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

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

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-prisma/src/prisma-publish-storage.ts:219

Parameters

id

string

error

unknown

options

MarkPublishFailedOptions

Returns

Promise<boolean>

Implementation of

PublishStoragePort.markPublishFailed


releaseExpiredClaims()

releaseExpiredClaims(now): Promise<void>

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:293

Parameters

now

Date

Returns

Promise<void>

Implementation of

PublishStoragePort.releaseExpiredClaims


renewPublishClaim()

renewPublishClaim(options): Promise<boolean>

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:267

Parameters

options

RenewPublishClaimOptions

Returns

Promise<boolean>

Implementation of

PublishStoragePort.renewPublishClaim


savePublish()

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

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:90

Type Parameters

T

T extends JsonValue = JsonValue

Parameters

event

CapPublishEvent<T>

ctx?

CapOperationContext<TransactionClient>

Returns

Promise<string>

Implementation of

PublishStoragePort.savePublish


savePublishWithTx()

savePublishWithTx<T>(event, tx): Promise<string>

Defined in: cap-storage-prisma/src/prisma-publish-storage.ts:108

Type Parameters

T

T extends JsonValue = JsonValue

Parameters

event

CapPublishEvent<T>

tx

Prisma.TransactionClient

Returns

Promise<string>

Deprecated

Use savePublish(event, { tx }) instead.