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

Standard library for Node.js

/// <reference types="node" />
/// <reference types="node" />
import { ZlibOptions } from 'zlib';
import { NDJsonStats } from './ndjson.model';
import { TransformToNDJsonOptions } from './transformToNDJson';
export interface PipelineToNDJsonFileOptions extends TransformToNDJsonOptions {
    filePath: string;
    /**
     * @default false
     * If true - will fail if output file already exists.
     */
    protectFromOverwrite?: boolean;
    /**
     * @default false
     */
    gzip?: boolean;
    /**
     * Only applicable if `gzip` is enabled
     */
    zlibOptions?: ZlibOptions;
}
/**
 * Convenience pipeline to transform stream of objects into a file in NDJSON format.
 *
 * Does fs.ensureFile() before starting, which will create all needed directories and truncate the file if it existed.
 */
export declare function pipelineToNDJsonFile(streams: (NodeJS.ReadableStream | NodeJS.WritableStream)[], opt: PipelineToNDJsonFileOptions): Promise<NDJsonStats>;