UNPKG

1.81 kBTypeScriptView Raw
1/// <reference types="node" />
2import { CellParser } from "./Parameters";
3import { Converter, PreRawDataCallback, PreFileLineCallback } from "./Converter";
4import CSVError from "./CSVError";
5export interface ParseRuntime {
6 /**
7 * If need convert ignoreColumn from column name(string) to column index (number). Parser needs column index.
8 */
9 needProcessIgnoreColumn: boolean;
10 /**
11 * If need convert includeColumn from column name(string) to column index (number). Parser needs column index.
12 */
13 needProcessIncludeColumn: boolean;
14 /**
15 * the indexes of columns to reserve, undefined means reserve all, [] means hide all
16 */
17 selectedColumns?: number[];
18 ended: boolean;
19 hasError: boolean;
20 error?: Error;
21 /**
22 * Inferred delimiter
23 */
24 delimiter: string | string[];
25 /**
26 * Inferred eol
27 */
28 eol?: string;
29 /**
30 * Converter function for a column. Populated at runtime.
31 */
32 columnConv: (CellParser | null)[];
33 headerType: any[];
34 headerTitle: string[];
35 headerFlag: any[];
36 /**
37 * Inferred headers
38 */
39 headers?: any[];
40 csvLineBuffer?: Buffer;
41 /**
42 * after first chunk of data being processed and emitted, started will become true.
43 */
44 started: boolean;
45 preRawDataHook?: PreRawDataCallback;
46 preFileLineHook?: PreFileLineCallback;
47 parsedLineNumber: number;
48 columnValueSetter: Function[];
49 subscribe?: {
50 onNext?: (data: any, lineNumber: number) => void | PromiseLike<void>;
51 onError?: (err: CSVError) => void;
52 onCompleted?: () => void;
53 };
54 then?: {
55 onfulfilled: (value: any[]) => any;
56 onrejected: (err: Error) => any;
57 };
58}
59export declare function initParseRuntime(converter: Converter): ParseRuntime;