Class ReadCase<T>`Sealed`

Type Parameters

T

Hierarchy

ReadCase

Implements

ReadCaseLike

Index

Constructors

Properties

Accessors

Methods

Constructors

`Private` constructor

new ReadCase<T>(ch: Chan<T>): ReadCase<T>
Type Parameters
- T
Parameters
- ch: Chan<T>
Returns ReadCase<T>
- Defined in src/channel.ts:737

Properties

`Private` `Readonly` ch

ch: Chan<T>

`Private` `Optional` read_

read_?: IteratorResult<T, any>

Accessors

isReady

get isReady(): boolean
Returns whether this case is ready

Returns boolean
Implementation of ReadCaseLike.isReady
- Defined in src/channel.ts:774

Methods

read

read(): undefined | T
Returns the value read by the case, throws an exception if the case is not ready

Throw
ChannelException
- ChannelCause.ReadCase
Returns undefined | T
Implementation of ReadCaseLike.read
- Defined in src/channel.ts:745

readRaw

readRaw(): [undefined, false] | [T, true]
Returns the value read by the case, throws an exception if the case is not ready

Throw
ChannelException
- ChannelCause.ReadCase
Returns [undefined, false] | [T, true]
Implementation of ReadCaseLike.readRaw
- Defined in src/channel.ts:757

Generated using TypeDoc