mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
92 lines
3.6 KiB
TypeScript
92 lines
3.6 KiB
TypeScript
// Type definitions for csv-stringify 1.4
|
|
// Project: https://github.com/wdavidw/node-csv-stringify, https://csv.js.org/stringify
|
|
// Definitions by: Rogier Schouten <https://github.com/rogierschouten>
|
|
// Arjen van der Ende <https://github.com/arjenvanderende>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
declare namespace stringify {
|
|
interface StringifyOpts {
|
|
/**
|
|
* List of fields, applied when transform returns an object.
|
|
* Order matters, read the transformer documentation for additionnal information,
|
|
* columns are auto discovered when the user write object, see the "header" option on how to print columns names on the first line.
|
|
*/
|
|
columns?: { [index: string]: string } | string[];
|
|
/**
|
|
* Set the field delimiter, one character only, defaults to a comma.
|
|
*/
|
|
delimiter?: string;
|
|
/**
|
|
* Add the value of "options.rowDelimiter" on the last line, default to true.
|
|
*/
|
|
eof?: boolean;
|
|
/**
|
|
* Defaults to the escape read option.
|
|
*/
|
|
escape?: boolean;
|
|
/**
|
|
* Display the column names on the first line if the columns option is provided or discovered.
|
|
*/
|
|
header?: boolean;
|
|
/**
|
|
* String used to delimit record rows or a special value;
|
|
* special values are 'auto', 'unix', 'mac', 'windows', 'unicode'; defaults to 'auto' (discovered in source or 'unix' if no source is specified).
|
|
*/
|
|
lineBreaks?: string;
|
|
/**
|
|
* Defaults to the quote read option.
|
|
*/
|
|
quote?: string;
|
|
/**
|
|
* Boolean, default to false, quote all the non-empty fields even if not required.
|
|
*/
|
|
quoted?: boolean;
|
|
/**
|
|
* Boolean, no default, quote empty fields? If specified, overrides quotedString for empty strings.
|
|
*/
|
|
quotedEmpty?: boolean;
|
|
/**
|
|
* Boolean, default to false, quote all fields of type string even if not required.
|
|
*/
|
|
quotedString?: boolean;
|
|
/**
|
|
* String used to delimit record rows or a special value;
|
|
* special values are 'auto', 'unix', 'mac', 'windows', 'unicode'; defaults to 'auto' (discovered in source or 'unix' if no source is specified).
|
|
*/
|
|
rowDelimiter?: string;
|
|
/**
|
|
* Override serialization of boolean, dates and complex objects.
|
|
*/
|
|
formatters?: FormatterOpts;
|
|
}
|
|
|
|
interface FormatterOpts {
|
|
bool?: (value: boolean) => string;
|
|
date?: (value: Date) => string;
|
|
object?: (value: any) => string;
|
|
}
|
|
|
|
interface Stringifier extends NodeJS.ReadWriteStream {
|
|
// Stringifier stream takes array of strings or Object, and optional encoding and callback
|
|
write(line: string[] | any, encoding?: string, cb?: (error: Error | undefined, output: string) => void): boolean;
|
|
|
|
// repeat declarations from NodeJS.WritableStream to avoid compile error
|
|
write(buffer: string | Buffer, cb?: (error: Error | undefined, output: string) => void): boolean;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Streaming stringifier
|
|
*/
|
|
declare function stringify(opts?: stringify.StringifyOpts): stringify.Stringifier;
|
|
|
|
/**
|
|
* Callback version: string in --> callback with string out
|
|
*/
|
|
declare function stringify(input: any[][] | Array<{}>, opts: stringify.StringifyOpts, callback: (error: Error | undefined, output: string) => void): void;
|
|
declare function stringify(input: any[][] | Array<{}>, callback: (error: Error | undefined, output: string) => void): void;
|
|
|
|
export = stringify;
|