fs-capacitor

  • Version 7.0.1
  • Published
  • 30.9 kB
  • No dependencies
  • MIT license

Install

npm i fs-capacitor
yarn add fs-capacitor
pnpm add fs-capacitor

Overview

Filesystem-buffered, passthrough stream that buffers indefinitely rather than propagate backpressure from downstream consumers.

Index

Variables

variable _default

const _default: {
WriteStream: typeof WriteStream;
ReadStream: typeof ReadStream;
ReadAfterDestroyedError: typeof ReadAfterDestroyedError;
ReadAfterReleasedError: typeof ReadAfterReleasedError;
};

    Classes

    class ReadAfterDestroyedError

    class ReadAfterDestroyedError extends Error {}

      class ReadAfterReleasedError

      class ReadAfterReleasedError extends Error {}

        class ReadStream

        class ReadStream extends Readable {}

          constructor

          constructor(writeStream: WriteStream, options?: ReadStreamOptions);

            class WriteStream

            class WriteStream extends Writable {}

              constructor

              constructor(options?: WriteStreamOptions);

                method createReadStream

                createReadStream: (options?: ReadStreamOptions) => ReadStream;

                  method release

                  release: () => void;

                    Interfaces

                    interface ReadStreamOptions

                    interface ReadStreamOptions {}

                      property encoding

                      encoding?: ReadableOptions['encoding'];

                        property highWaterMark

                        highWaterMark?: ReadableOptions['highWaterMark'];

                          interface WriteStreamOptions

                          interface WriteStreamOptions {}

                            property defaultEncoding

                            defaultEncoding?: WritableOptions['defaultEncoding'];

                              property highWaterMark

                              highWaterMark?: WritableOptions['highWaterMark'];

                                property tmpdir

                                tmpdir?: () => string;

                                  Package Files (1)

                                  Dependencies (0)

                                  No dependencies.

                                  Dev Dependencies (10)

                                  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/fs-capacitor.

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