cap-nodejs

CAP Node.js API


CAP Node.js API / cap-nest/src / CapService

Class: CapService

Defined in: cap-nest/src/cap/cap.service.ts:38

Constructors

Constructor

new CapService(engine): CapService

Defined in: cap-nest/src/cap/cap.service.ts:41

Parameters

engine

CapEngine

Returns

CapService

Constructor

new CapService(pubStore, recStore, publisher, subscriber, schedulerOptions?): CapService

Defined in: cap-nest/src/cap/cap.service.ts:42

Parameters

pubStore

IPublishStorage

recStore

IReceivedStorage

publisher

IPublisher

subscriber

ISubscriber

schedulerOptions?

ResolvedCapSchedulerOptions

Returns

CapService

Methods

close()

close(): Promise<void>

Defined in: cap-nest/src/cap/cap.service.ts:112

Returns

Promise<void>


dispatchOutboxBatch()

dispatchOutboxBatch(): Promise<number>

Defined in: cap-nest/src/cap/cap.service.ts:104

Returns

Promise<number>


publish()

publish<T>(topic, payload, options?): Promise<void>

Defined in: cap-nest/src/cap/cap.service.ts:77

Type Parameters

T

T = JsonValue

Parameters

topic

string

payload

T

options?

CapPublishOptions = {}

Returns

Promise<void>


retryInboxBatch()

retryInboxBatch(): Promise<number>

Defined in: cap-nest/src/cap/cap.service.ts:108

Returns

Promise<number>


retryReceived()

retryReceived(rec): Promise<void>

Defined in: cap-nest/src/cap/cap.service.ts:100

Parameters

rec

CapReceivedEvent

Returns

Promise<void>


subscribe()

subscribe<T>(topic, group, handler): void

Defined in: cap-nest/src/cap/cap.service.ts:85

Type Parameters

T

T = unknown

Parameters

topic

string

group

string

handler

Handler<T>

Returns

void


transaction()

transaction<T>(fn, options?): Promise<T>

Defined in: cap-nest/src/cap/cap.service.ts:93

Type Parameters

T

T

Parameters

fn

(ctx) => Promise<T>

options?

CapTransactionOptions

Returns

Promise<T>