UNPKG

706 BTypeScriptView Raw
1/// <reference types="node" />
2import { ZlibOptions } from 'zlib';
3import { NDJsonStats } from './ndjson.model';
4import { TransformJsonParseOptions } from './transformJsonParse';
5export interface PipelineFromNDJsonFileOptions extends TransformJsonParseOptions {
6 filePath: string;
7 /**
8 * @default `\n`
9 */
10 separator?: string;
11 /**
12 * @default false
13 */
14 gzip?: boolean;
15 /**
16 * Only applicable if `gzip` is enabled
17 */
18 zlibOptions?: ZlibOptions;
19}
20/**
21 * Convenience pipeline that starts from reading NDJSON file.
22 */
23export declare function pipelineFromNDJsonFile(streams: NodeJS.WritableStream[], opt: PipelineFromNDJsonFileOptions): Promise<NDJsonStats>;