UNPKG

gulp-etl-tap-csv

Version:

Convert CSV files to JSON compatible with gulp-etl

25 lines (24 loc) 1.47 kB
export declare const PLUGIN_NAME: any; export declare let localDefaultConfigObj: any; interface ConvertParams { streamName: string; configObj: any; } /** * Convert a standard object into an JSONL line; suitable for calling directly or as a Handler for [stream-transform](https://csv.js.org/transform/handler/) * @param dataObj An object (from csvParse) representing a line * @param params A `params` object; may be passed in directly, or, when calling as a stream-transform handler it is passed as `options.params` . * NOTE: params is REQUIRED; if no params is passed when run as a Handler, the whole stream will fail quietly. * @returns A [RECORD Message](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md#record-message) created from dataObj, as a string */ export declare function convertCsvObjectToRecordLine(dataObj: Object, params?: ConvertParams | any): string | null; /** * Converts a string/buffer CSV input into an a Message Stream * @param csvLines A string or Buffer representing CSV lines * @param streamName name to use for the "stream" property of each Message Stream record * @param configObj [CSV Stringify options object](https://csv.js.org/stringify/options/); optional * @returns A string representation of the CSV lines */ export declare function csvParseText(csvLines: string | Buffer, streamName: string, configObj?: Object): Promise<string>; export declare function tapCsv(origConfigObj: any): any; export {};