@types/split
Version:
TypeScript definitions for split
39 lines (28 loc) • 1.25 kB
Markdown
# Installation
> `npm install --save @types/split`
# Summary
This package contains type definitions for split (https://github.com/dominictarr/split).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/split.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/split/index.d.ts)
````ts
/// <reference types="node" />
/// <reference types="through" />
import { ThroughStream } from "through";
// doc-strings taken from https://github.com/dominictarr/split, used under MIT license
interface SplitOptions {
maxLength?: number;
/**
* By default the last buffer not delimited by a newline or `matcher` will be emitted.
* To prevent this set `options.trailing` to `false`.
*/
trailing?: boolean;
}
declare function split(matcher?: any, mapper?: any, options?: SplitOptions): ThroughStream;
export = split;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 15:11:36 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/through](https://npmjs.com/package/@types/through)
# Credits
These definitions were written by [Marcin Porębski](https://github.com/marcinporebski).