Logo for jsDocs.io

@types/stream-buffers

  • Version 3.0.8
  • Published
  • 5 kB
  • 1 dependency
  • MIT license

Install

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

Overview

TypeScript definitions for stream-buffers

Index

Variables

Classes

Interfaces

Variables

variable DEFAULT_CHUNK_SIZE

const DEFAULT_CHUNK_SIZE: number;

    variable DEFAULT_FREQUENCY

    const DEFAULT_FREQUENCY: number;

      variable DEFAULT_INCREMENT_AMOUNT

      const DEFAULT_INCREMENT_AMOUNT: number;

        variable DEFAULT_INITIAL_SIZE

        const DEFAULT_INITIAL_SIZE: number;

          Classes

          class ReadableStreamBuffer

          class ReadableStreamBuffer extends stream.Readable {}

            constructor

            constructor(options?: ReadableStreamBufferOptions);

              method maxSize

              maxSize: () => number;

                method put

                put: (data: string | Buffer, encoding?: string) => void;

                  method size

                  size: () => number;

                    method stop

                    stop: () => void;

                      class WritableStreamBuffer

                      class WritableStreamBuffer extends stream.Writable {}

                        constructor

                        constructor(options?: WritableStreamBufferOptions);

                          method getContents

                          getContents: (length?: number) => Buffer | false;

                            method getContentsAsString

                            getContentsAsString: (encoding?: string, length?: number) => string | false;

                              method maxSize

                              maxSize: () => number;

                                method size

                                size: () => number;

                                  Interfaces

                                  interface ReadableStreamBufferOptions

                                  interface ReadableStreamBufferOptions extends stream.ReadableOptions {}

                                    property chunkSize

                                    chunkSize?: number | undefined;

                                      property frequency

                                      frequency?: number | undefined;

                                        property incrementAmount

                                        incrementAmount?: number | undefined;

                                          property initialSize

                                          initialSize?: number | undefined;

                                            interface WritableStreamBufferOptions

                                            interface WritableStreamBufferOptions extends stream.WritableOptions {}

                                              property incrementAmount

                                              incrementAmount?: number | undefined;

                                                property initialSize

                                                initialSize?: number | undefined;

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

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