Skip to main content

@terascope/job-components / index / RouteSenderAPI

Interface: RouteSenderAPI

Used for sending data to particular index/topic/file/table in a storage system. This is used by the routed sender in the standard-assets

Methods

send()

send(records): Promise<number>

Sends the records to the respective storage backend

Parameters

ParameterType
recordsIterable<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>>

Returns

Promise<number>

the number of affected records/rows

Source

packages/utils/dist/src/interfaces.d.ts:13


verify()?

optional verify(route?): Promise<void>

This is used to verify and create an resources required for this particular route

This is optional to implement

Parameters

ParameterType
route?string

Returns

Promise<void>

Source

packages/utils/dist/src/interfaces.d.ts:20