@types/combined-stream

  • Version 1.0.3
  • Published
  • 7.09 kB
  • 1 dependency
  • MIT license

Install

npm i @types/combined-stream
yarn add @types/combined-stream
pnpm add @types/combined-stream

Overview

TypeScript definitions for combined-stream

Index

Classes

class CombinedStream

class CombinedStream extends Stream implements Options {}

    property dataSize

    readonly dataSize: number;

      property maxDataSize

      maxDataSize: number;

        property pauseStreams

        pauseStreams: boolean;

          property readable

          readonly readable: boolean;

            property writable

            readonly writable: boolean;

              method append

              append: (stream: Appendable) => this;

                method create

                static create: (options?: Options) => CombinedStream;

                  method destroy

                  destroy: () => void;

                    method end

                    end: () => void;

                      method isStreamLike

                      static isStreamLike: (stream: any) => stream is any;

                        method on

                        on: {
                        (event: 'close' | 'end' | 'resume' | 'pause', cb: () => void): this;
                        (event: 'error', cb: (err: Error) => void): this;
                        (event: 'data', cb: (data: any) => void): this;
                        };

                          method once

                          once: {
                          (event: 'close' | 'end' | 'resume' | 'pause', cb: () => void): this;
                          (event: 'error', cb: (err: Error) => void): this;
                          (event: 'data', cb: (data: any) => void): this;
                          };

                            method pause

                            pause: () => void;

                              method resume

                              resume: () => void;

                                method write

                                write: (data: any) => void;

                                  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/combined-stream.

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