Github Link
      ⚠️ Internal: This API is not publically exported by the package.

      Interface ReadableOptions<T>

      interface ReadableOptions {
          autoDestroy?: boolean;
          emitClose?: boolean;
          encoding?: BufferEncoding;
          highWaterMark?: number;
          objectMode?: boolean;
          signal?: AbortSignal;
          construct?(this, callback): void;
          destroy?(this, error, callback): void;
          read?(this, size): void;
      }

      Type Parameters

      Hierarchy

      Methods

      construct? destroy? read?

      Properties

      autoDestroy? emitClose? encoding? highWaterMark? objectMode? signal?

      Methods

      Optional construct

      • construct(this, callback): void

      • Parameters

        • this: T
        • callback: ((error?) => void)
            • (error?): void

            • Parameters

              Returns void

        Returns void

      Optional destroy

      • destroy(this, error, callback): void

      • Parameters

        • this: T
        • error: Error
        • callback: ((error?) => void)
            • (error?): void

            • Parameters

              Returns void

        Returns void

      Optional read

      • read(this, size): void

      • Parameters

        • this: T
        • size: number

        Returns void

      Properties

      Optional autoDestroy

      autoDestroy?: boolean

      Optional emitClose

      emitClose?: boolean

      Optional encoding

      encoding?: BufferEncoding

      Optional highWaterMark

      highWaterMark?: number

      Optional objectMode

      objectMode?: boolean

      Optional signal

      signal?: AbortSignal

      When provided the corresponding AbortController can be used to cancel an asynchronous action.

      Settings

      Member Visibility

      Theme

      On This Page