Interface IngestOptions<T>

interface IngestOptions<T extends BaseModel> {
    destination: BaseRepo<T>;
    fieldMappings?: Record<string, keyof T>;
    fields: (keyof T)[];
    onSaved?: (doc: Saved<T>, originalDoc: Saved<T>) => Promise<void>;
    source: Readable;
    transform?: IngestTransform<T>;
}

Type Parameters

  • T extends BaseModel

Properties

destination fieldMappings? fields onSaved? source transform?

Properties

destination

destination: BaseRepo<T>

The destination repository

OptionalfieldMappings

fieldMappings?: Record<string, keyof T>

The field mappings from the source record to the destination document

fields

fields: (keyof T)[]

The fields to update

OptionalonSaved

onSaved?: (doc: Saved<T>, originalDoc: Saved<T>) => Promise<void>

A function to run after the document is saved

Type declaration

    • (doc: Saved<T>, originalDoc: Saved<T>): Promise<void>

    • Parameters

      • doc: Saved<T>

        The document that was saved

      • originalDoc: Saved<T>

      Returns Promise<void>

source

source: Readable

The source data stream

Optionaltransform

transform?: IngestTransform<T>

A transform function to apply to the document before saving

Settings

Member Visibility

On This Page

Properties