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

      Interface OnReadOpts

      interface OnReadOpts {
          buffer: Uint8Array | (() => Uint8Array);
          callback(bytesWritten, buf): boolean;
      }

      Methods

      callback

      Properties

      buffer

      Methods

      callback

      • callback(bytesWritten, buf): boolean

      • This function is called for every chunk of incoming data. Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer. Return false from this function to implicitly pause() the socket.

        Parameters

        Returns boolean

      Properties

      buffer

      buffer: Uint8Array | (() => Uint8Array)

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page