OCP App SDK

---

OCP App SDK / Destination

Class: abstract Destination<T>

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

Type Parameters

T

T

Constructors

Constructor

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

Returns

Destination<T>

Methods

deliver()

abstract deliver(batch): Promise<DestinationDeliverResult>

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

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

Parameters

batch

DestinationBatch<T>

The batch to be delivered

Returns

Promise<DestinationDeliverResult>

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

---

ready()

abstract ready(): Promise<DestinationReadyResult>

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

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.

Returns

Promise<DestinationReadyResult>

true if the destination ready to use

Async