prorm API Reference
    Preparing search index...

    Interface StreamExportOptions

    interface StreamExportOptions {
        where?: Record<string, any>;
        include?: any[];
        format?: ExportFormat;
        excludeForRole?: string;
        limit?: number;
        order?: any[];
        onChunk: (chunk: string) => void | Promise<void>;
        batchSize?: number;
    }

    Hierarchy (View Summary)

    Index
    where? include? format? excludeForRole? limit? order? onChunk batchSize?
    where?: Record<string, any>

    Where clause to select records

    include?: any[]

    Include associated models

    format?: ExportFormat

    Output format. Default: 'json'

    excludeForRole?: string

    Roles whose fields should be excluded from export

    limit?: number

    Maximum records to export. Default: unlimited

    order?: any[]

    Order clause

    onChunk: (chunk: string) => void | Promise<void>

    Callback for each chunk of data

    batchSize?: number

    Batch size for streaming. Default: 100

    Settings
    Member Visibility

    On This Page
    Properties