Shared stream contracts for Eryx.

This module provides:

1. Structural stream types (ReadableStream, WritableStream, ReadWriteStream, and Stream) for static typing.

Design intent

• Native objects should "just be streams" by shape, not inheritance. fs.File, _socket.Socket, and _ssl.SslSocket can satisfy these contracts directly via structural typing.
• Capabilities are represented in types with tags: readable: true/false and writable: true/false.
• Runtime compatibility is preserved: some concrete objects may still expose methods that can error when capability is invalid.

Return conventions

• nil means EOF (or closed peer for read-like operations).
• Socket-specific would-block signaling is exposed by @eryx/_socket via _socket.WOULD_BLOCK, not this shared module.

Quick examples

Use @eryx/stdio for process-owned stream handles:

• stdio.stdin
• stdio.stdout
• stdio.stderr

Summary

Classes

API Reference

Classes

ReadableStream

Read-only stream contract.

read and readSync are intentionally generic and may return either string or buffer depending on the concrete stream source. Use readBuffer variants when you specifically need buffer.

Properties

readable: true

writable: false

closed: boolean?

ReadableStream:read

ReadableStream:read(size: number?) → string | nil

ReadableStream:readSync

ReadableStream:readSync(size: number?) → string | nil

ReadableStream:readBuffer

ReadableStream:readBuffer(size: number?) → buffer | nil

ReadableStream:readBufferSync

ReadableStream:readBufferSync(size: number?) → buffer | nil

ReadableStream:close

ReadableStream:close() → ()

ReadableStream:closeSync

ReadableStream:closeSync() → ()

WritableStream

Write-only stream contract.

write and writeSync accept string | buffer to support both text and binary producer code with one surface.

Properties

readable: false

writable: true

closed: boolean?

WritableStream:write

WritableStream:write(data: string | buffer) → number

WritableStream:writeSync

WritableStream:writeSync(data: string | buffer) → number

WritableStream:close

WritableStream:close() → ()

WritableStream:closeSync

WritableStream:closeSync() → ()

ReadWriteStream

Duplex stream contract.

This is effectively ReadableStream & WritableStream with explicit tags.

Properties

readable: true

writable: true

closed: boolean?

ReadWriteStream:read

ReadWriteStream:read(size: number?) → string | nil

ReadWriteStream:readSync

ReadWriteStream:readSync(size: number?) → string | nil

ReadWriteStream:readBuffer

ReadWriteStream:readBuffer(size: number?) → buffer | nil

ReadWriteStream:readBufferSync

ReadWriteStream:readBufferSync(size: number?) → buffer | nil

ReadWriteStream:write

ReadWriteStream:write(data: string | buffer) → number

ReadWriteStream:writeSync

ReadWriteStream:writeSync(data: string | buffer) → number

ReadWriteStream:close

ReadWriteStream:close() → ()

ReadWriteStream:closeSync

ReadWriteStream:closeSync() → ()

Types

Stream

Union of all stream capability variants.

type Stream = ReadableStream | WritableStream | ReadWriteStream