@types/from2

  • Version 2.3.5
  • Published
  • 5.5 kB
  • 1 dependency
  • MIT license

Install

npm i @types/from2
yarn add @types/from2
pnpm add @types/from2

Overview

TypeScript definitions for from2

Index

Functions

function ctor

ctor: {
(opts?: Options): From2Ctor<ReadInput>;
(opts: any): From2Ctor<ReadObjectInput>;
};

    function from2

    from2: typeof from2;

      function obj

      obj: {
      (read: ReadObjectInput): Stream;
      (opts: any, read: ReadObjectInput): Stream;
      };

        Interfaces

        interface Stream

        interface Stream extends NodeJS.ReadableStream {}

          property destroy

          destroy: (err?: Error) => void;

            property destroyed

            readonly destroyed: boolean;

              Type Aliases

              type Chunk

              type Chunk = string | Buffer | Uint8Array | null;

                type From2Ctor

                type From2Ctor<R extends ReadInput | ReadObjectInput> = new (read: R) => Stream;

                  type NextCallback

                  type NextCallback = (err: any | undefined, chunk: Chunk) => void;

                    type NextObjectCallback

                    type NextObjectCallback = (err: any | undefined, chunk: any) => void;

                      type ObjectModeOptions

                      type ObjectModeOptions = { objectMode: true } & stream.ReadableOptions;

                        type Options

                        type Options = { objectMode?: false | undefined } & stream.ReadableOptions;

                          type ReadCallback

                          type ReadCallback<N extends NextCallback | NextObjectCallback> = (
                          size: number,
                          next: N
                          ) => void;

                            type ReadInput

                            type ReadInput = ReadCallback<NextCallback> | Chunk[];

                              type ReadObjectInput

                              type ReadObjectInput = ReadCallback<NextObjectCallback> | any[];

                                Package Files (1)

                                Dependencies (1)

                                Dev Dependencies (0)

                                No dev dependencies.

                                Peer Dependencies (0)

                                No peer dependencies.

                                Badge

                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/from2.

                                • Markdown
                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/from2)
                                • HTML
                                  <a href="https://www.jsdocs.io/package/@types/from2"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>