Skip to main content
Version: Current

CsvFile

@rotorsoft/act-root


@rotorsoft/act-root / act/src / CsvFile

Class: CsvFile

Defined in: libs/act/src/csv.ts:54

Read end of the transfer pipeline (ACT-1128 / #788). Anything that exposes a Store.query-shaped reader plus dispose can be used as a source for IAct.restore.

Store extends this interface; the framework's CsvFile utility implements it on top of file I/O so a CSV can be a transfer source. The pipeline never sees a discriminator โ€” both ends speak the same shape.

Implementsโ€‹

Constructorsโ€‹

Constructorโ€‹

new CsvFile(options): CsvFile

Defined in: libs/act/src/csv.ts:58

Parametersโ€‹

optionsโ€‹

CsvFileOptions

Returnsโ€‹

CsvFile

Methodsโ€‹

dispose()โ€‹

dispose(): Promise<void>

Defined in: libs/act/src/csv.ts:142

Returnsโ€‹

Promise<void>

Implementation ofโ€‹

EventSource.dispose


query()โ€‹

query<E>(callback, _filter?): Promise<number>

Defined in: libs/act/src/csv.ts:68

Read events into a per-event callback. Adapters MUST await Promise.resolve(callback(event)) per event โ€” sync callbacks resolve immediately (zero overhead), async callbacks throttle the read loop. This is the seam that lets iterate() apply backpressure without changing the callback's declared return type. Callback returns void, which TypeScript treats as "return value ignored" โ€” existing call sites passing e => arr.push(e) (which returns number) keep working.

Type Parametersโ€‹

Eโ€‹

E extends Schemas

Parametersโ€‹

callbackโ€‹

(event) => void

_filter?โ€‹

Readonly<{ after?: number; backward?: boolean; before?: number; correlation?: string; created_after?: Date; created_before?: Date; limit?: number; names?: string[]; stream?: string; stream_exact?: boolean; with_snaps?: boolean; }>

Returnsโ€‹

Promise<number>

Implementation ofโ€‹

EventSource.query


restore()โ€‹

restore(driver): Promise<void>

Defined in: libs/act/src/csv.ts:107

Parametersโ€‹

driverโ€‹

(callback) => Promise<void>

Returnsโ€‹

Promise<void>

Implementation ofโ€‹

EventSink.restore