@types/split2

Installation

npm install --save @types/split2

Summary

This package contains type definitions for split2 (https://github.com/mcollina/split2).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/split2.

index.d.ts

// Type definitions for split2 4.2
// Project: https://github.com/mcollina/split2
// Definitions by: TANAKA Koichi <https://github.com/mugeso>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />

import { Transform, TransformOptions } from "stream";

declare function split(matcher: split.Matcher, Mapper: split.Mapper, options?: split.Options): Transform;
declare function split(mapper: split.Mapper, options?: split.Options): Transform;
// tslint:disable-next-line unified-signatures
declare function split(matcher: split.Matcher, options?: split.Options): Transform;
declare function split(options?: split.Options): Transform;

declare namespace split {
    interface Mapper {
        (line: string): any;
    }

    interface Options extends TransformOptions {
        maxLength?: number | undefined;
    }
    type Matcher = string | RegExp | { [Symbol.split](string: string, limit?: number): string[] };
}

export = split;

Additional Details

• Last updated: Mon, 25 Sep 2023 13:39:06 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by TANAKA Koichi.