OCP App SDK / Destination

Destination<T>

Type parameters

• T

Index

Constructors

• constructor

Methods

• deliver
• ready

Constructors

constructor()

Signature

new Destination<T>(): Destination<T>;

Type parameters

• T

Returns

Destination<T>

Methods

deliver()

Delivers the given batch to i.e. an external system.

Signature

Abstract deliver(batch: DestinationBatch<T>): Promise<DestinationDeliverResult>;

Parameters

Returns

Promise<DestinationDeliverResult>

A DestinationDeliverResult with success/failure,
if the batch should be retried and a failure reason if applicable.

Defined in: src/app/Destination.ts:56

ready()

Checks if the Destination ready to use.
This should ensure that any required credentials and/or other configuration exist and are valid.
Reasonable caching should be utilized to prevent excessive requests to external resources.

Async

Signature

Abstract ready(): Promise<DestinationReadyResult>;

Returns

Promise<DestinationReadyResult>

true if the destination ready to use

Defined in: src/app/Destination.ts:48