Interface ReadChannel<T>

a read-only channel

Type Parameters

T

Hierarchy

ReadChannel
- Channel

Implemented by

Chan

Index

Properties

capacity isClosed length

Methods

[asyncIterator] read readCase readRaw tryRead wait

Properties

`Readonly` capacity

capacity: number

Returns how much data the channel has buffered

`Readonly` isClosed

isClosed: boolean

Returns whether the channel is closed

`Readonly` length

length: number

Returns the channel buffer size

Methods

[asyncIterator]

[asyncIterator](): AsyncGenerator<T, any, unknown>
Implement asynchronous iterators

Returns AsyncGenerator<T, any, unknown>
- Defined in src/channel.ts:65

read

read(): ReadReturn<T>
Read a value from the channel, block if there is no value to read, and return until there is a value or the channel is closed

Returns ReadReturn<T>
- Defined in src/channel.ts:33

readCase

readCase(): ReadCase<T>
Create a case for select to read

Returns ReadCase<T>
- Defined in src/channel.ts:52

readRaw

readRaw(): ReadRawReturn<T>
Read a value from the channel, block if there is no value to read, and return until there is a value or the channel is closed

Returns ReadRawReturn<T>
- Defined in src/channel.ts:37

tryRead

tryRead(): undefined | IteratorResult<T, any>
Attempts to read a value from the channel, returns undefined if no value is readable, returns {done:true} if the channel is closed

Returns undefined | IteratorResult<T, any>
- Defined in src/channel.ts:43

wait

wait(): undefined | Promise<void>
Wait for chan to close, no data will be read from chan

Returns undefined | Promise<void>
- Defined in src/channel.ts:70

Generated using TypeDoc