Interface Stream

Readonly[toStringTag]

fileno

• get fileno(): number

  Get underlying file descriptor

  Returns number

  File descriptor number

close

• close(): void

  Fully close stream and release resources

  Returns void

  Throws

  Synchronous throw on error

listen

• listen(backlog?: number): void

  Start listening for incoming connections (server mode only)

  Parameters

  • Optionalbacklog: number

    Maximum pending connection queue length, default 511

  Returns void

  Throws

  Synchronous throw on error (already listening, invalid handle, etc.)

onconnection

• onconnection(error: undefined, client: Stream): void

  New connection callback - on successful accept

  Parameters

  • error: undefined

    undefined

  • client: Stream

    New client Stream object

  Returns void

• onconnection(error: Error, client: undefined): void

  New connection callback - on accept failure

  Parameters

  • error: Error

    Error object

  • client: undefined

    undefined

  Returns void

onread

• onread(result: Uint8Array<ArrayBuffer>, error: undefined): void

  Read data callback - on successful read

  Parameters

  • result: Uint8Array<ArrayBuffer>

    Read data (Uint8Array)

  • error: undefined

    undefined

  Returns void

• onread(result: null, error: undefined): void

  Read data callback - on EOF

  Parameters

  • result: null

    null (indicates EOF)

  • error: undefined

    undefined

  Returns void

• onread(result: undefined, error: Error): void

  Read data callback - on read failure

  Parameters

  • result: undefined

    undefined

  • error: Error

    Error object

  Returns void

read

• read(buffer: Uint8Array): Promise<number>

  Async read data into user buffer (zero-copy)

  Parameters

  • buffer: Uint8Array

    Uint8Array to store read data

  Returns Promise<number>

  Promise resolves to bytes read (0 = EOF), rejects on failure

readSync

• readSync(buffer: Uint8Array): number | null

  Sync read using OS-level blocking read()/recv()

  Parameters

  • buffer: Uint8Array

    Uint8Array to store read data

  Returns number | null

  Bytes read, null indicates EOF

  Throws

  Synchronous throw on error

ref

• ref(): void

  Increase event loop ref count, prevent handle from being reclaimed

  Returns void

setBlocking

• setBlocking(blocking: boolean): void

  Set stream to blocking or non-blocking mode

  Parameters

  • blocking: boolean

    true for blocking, false for non-blocking

  Returns void

  Throws

  Synchronous throw on error

shutdown

• shutdown(): void

  Shutdown write/read direction (synchronous, wraps uv_shutdown)

  Returns void

startRead

• startRead(): void

  Start reading data

  Returns void

stopRead

• stopRead(): void

  Stop reading data

  Returns void

unref

• unref(): void

  Decrease event loop ref count, allow handle to be reclaimed

  Returns void

write

• write(buffer: Uint8Array): Promise<number>

  Write data to stream

  Parameters

  • buffer: Uint8Array

    Uint8Array containing data to write

  Returns Promise<number>

  Promise resolves to bytes written, rejects on failure

writeSync

• writeSync(buffer: Uint8Array): number

  Sync write using OS-level blocking write()/send()

  Parameters

  • buffer: Uint8Array

    Uint8Array containing data to write

  Returns number

  Bytes written

  Throws

  Synchronous throw on error