Class ArraySource

A source backed by an in-memory array of RecordRef.

Implements

IRecordSetSource

Index

Constructors

Methods

Describe NextBatch

Constructors

constructor

new ArraySource(
    records: RecordRef[],
    entityID?: string,
    sourceType?: SourceTypeValue,
): ArraySource
Parameters
- records: RecordRef[]
  The records to yield.
- OptionalentityID: string
  Optional entity ID for the run header (otherwise taken from the first record).
- sourceType: SourceTypeValue = 'Array'
  Reported source type (default Array; pass SingleRecord for a one-record scope).
Returns ArraySource
- Defined in RecordSetProcessor/base/src/sources/arraySource.ts:17

Methods

Describe

Describe(): SourceDescriptor
Returns a persistable description of this source for the run header.

Returns SourceDescriptor
Implementation of IRecordSetSource.Describe
- Defined in RecordSetProcessor/base/src/sources/arraySource.ts:23

NextBatch

NextBatch(cursor: ProcessCursor, batchSize: number): Promise<RecordBatch>
Returns the next batch of records after the given cursor.
Parameters
- cursor: ProcessCursor
  The cursor returned by the previous batch, or undefined to start from the beginning.
- batchSize: number
  Maximum number of records to return.
Returns Promise<RecordBatch>
A batch with the records, the next cursor, and an exhausted flag.
Implementation of IRecordSetSource.NextBatch
- Defined in RecordSetProcessor/base/src/sources/arraySource.ts:27