@naturalcycles/nodejs-lib/dist/stream/ndjson/pipelineFromNDJsonFile.d.ts

Standard library for Node.js

/// <reference types="node" />
/// <reference types="node" />
import { ZlibOptions } from 'zlib';
import { NDJsonStats } from './ndjson.model';
import { TransformJsonParseOptions } from './transformJsonParse';
export interface PipelineFromNDJsonFileOptions extends TransformJsonParseOptions {
    filePath: string;
    /**
     * @default `\n`
     */
    separator?: string;
    /**
     * @default false
     */
    gzip?: boolean;
    /**
     * Only applicable if `gzip` is enabled
     */
    zlibOptions?: ZlibOptions;
}
/**
 * Convenience pipeline that starts from reading NDJSON file.
 */
export declare function pipelineFromNDJsonFile(streams: NodeJS.WritableStream[], opt: PipelineFromNDJsonFileOptions): Promise<NDJsonStats>;