mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4148e85675
Package docs allow `false` as a parameter to `stringify`, in addition to `stringify(open, sep, close)`. This is useful for dumping a stream of objects separated by newlines, rather than creating a JSON array of the objects. from https://www.npmjs.com/package/JSONStream > If you call JSONStream.stringify(false) the elements will only be > seperated by a newline.
40 lines
1.5 KiB
TypeScript
40 lines
1.5 KiB
TypeScript
// Type definitions for JSONStream v0.8.0
|
|
// Project: https://github.com/dominictarr/JSONStream
|
|
// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
|
|
|
|
export interface Options {
|
|
recurse: boolean;
|
|
}
|
|
|
|
export declare function parse(pattern: any): NodeJS.ReadWriteStream;
|
|
export declare function parse(patterns: any[]): NodeJS.ReadWriteStream;
|
|
|
|
|
|
/**
|
|
* Create a writable stream.
|
|
* you may pass in custom open, close, and seperator strings. But, by default,
|
|
* JSONStream.stringify() will create an array,
|
|
* (with default options open='[\n', sep='\n,\n', close='\n]\n')
|
|
*/
|
|
export declare function stringify(): NodeJS.ReadWriteStream;
|
|
|
|
/** If you call JSONStream.stringify(false) the elements will only be seperated by a newline. */
|
|
export declare function stringify(newlineOnly: NewlineOnlyIndicator): NodeJS.ReadWriteStream;
|
|
type NewlineOnlyIndicator = false
|
|
|
|
/**
|
|
* Create a writable stream.
|
|
* you may pass in custom open, close, and seperator strings. But, by default,
|
|
* JSONStream.stringify() will create an array,
|
|
* (with default options open='[\n', sep='\n,\n', close='\n]\n')
|
|
*/
|
|
export declare function stringify(open: string, sep: string, close: string): NodeJS.ReadWriteStream;
|
|
|
|
export declare function stringifyObject(): NodeJS.ReadWriteStream;
|
|
export declare function stringifyObject(open: string, sep: string, close: string): NodeJS.ReadWriteStream;
|