1.0.5 • Published 6 months ago

@types/split v1.0.5

Weekly downloads
41,508
License
MIT
Repository
github
Last release
6 months ago

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

// Type definitions for split v1.0.1
// Project: https://github.com/dominictarr/split
// Definitions by: Marcin Porębski <https://github.com/marcinporebski>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <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

Credits

These definitions were written by Marcin Porębski.