MetaStream | @thi.ng/rstream

Type parameters

Hierarchy

Subscription<A, B>
- MetaStream

Implements

IDeref
ISubscriber<A>
ISubscribable
ITransformable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MetaStream(factory: Fn<A, Subscription<B, B>>, opts?: Partial<MetaStreamOpts>): MetaStream

Overrides Subscription.constructor
- Defined in rstream/src/metastream.ts:109
Parameters
- factory: Fn<A, Subscription<B, B>>
- Default value opts: Partial<MetaStreamOpts> = {}
Returns MetaStream

Properties

Protected cacheLast

cacheLast: boolean

closeIn

closeIn: CloseMode

closeOut

closeOut: CloseMode

doneRequested

doneRequested: boolean

emitLast

emitLast: boolean

factory

factory: Fn<A, Subscription<B, B>>

id

id: string

Protected last

last: any

Protected Optional parent

parent: ISubscribable<A>

Protected state

state: State = State.IDLE

Optional stream

stream: Subscription<B, B>

Optional sub

sub: Subscription<B, B>

Protected subs

subs: ISubscriber[]

Protected Optional xform

xform: Reducer<B[], A>

Methods

Protected addWrapped

addWrapped(wrapped: Subscription<any, any>): Subscription<any, any>

Inherited from Subscription.addWrapped
- Defined in rstream/src/subscription.ts:339
Parameters
- wrapped: Subscription<any, any>
Returns Subscription<any, any>

Protected cleanup

cleanup(): void

Inherited from Subscription.cleanup
- Defined in rstream/src/subscription.ts:376
Returns void

deref

deref(): B | undefined

Implementation of ISubscribable.deref
Inherited from Subscription.deref
- Defined in rstream/src/subscription.ts:121
Returns B | undefined

Protected detach

detach(force: boolean): void

- Defined in rstream/src/metastream.ts:166
Parameters
- force: boolean
Returns void

Protected dispatch

dispatch(x: B): void

Inherited from Subscription.dispatch
- Defined in rstream/src/subscription.ts:345
Parameters
- x: B
Returns void

done

done(): void

Overrides Subscription.done
- Defined in rstream/src/metastream.ts:148
Returns void

Protected ensureState

ensureState(): void

Inherited from Subscription.ensureState
- Defined in rstream/src/subscription.ts:370
Returns void

error

error(e: any): void

Inherited from Subscription.error
- Defined in rstream/src/subscription.ts:317
Parameters
- e: any
Returns void

getState

getState(): State

Implementation of ISubscribable.getState
Inherited from Subscription.getState
- Defined in rstream/src/subscription.ts:125
Returns State

map

map<C>(fn: Fn<B, C>): Subscription<B, C>

Inherited from Subscription.map
- Defined in rstream/src/subscription.ts:227
Syntax sugar for Subscription.transform when using a single {@link @thi.ng/transducers#map} transducer only. The given function fn is used as map's transformation fn.
Type parameters
- C
Parameters
- fn: Fn<B, C>
Returns Subscription<B, C>

next(x: A): void

Overrides Subscription.next
- Defined in rstream/src/metastream.ts:121
Parameters
- x: A
Returns void

subscribe(sub: Partial<ISubscriber>, opts?: Partial<CommonOpts>): Subscription<B, B>
subscribe<C>(sub: Subscription<B, C>): Subscription<B, C>
subscribe<C>(xform: Transducer<B, C>, opts?: Partial<CommonOpts>): Subscription<B, C>
subscribe<C>(sub: Partial<ISubscriber<C>>, xform: Transducer<B, C>, opts?: Partial<CommonOpts>): Subscription<B, C>

Implementation of ISubscribable.subscribe
Inherited from Subscription.subscribe
- Defined in rstream/src/subscription.ts:133
Creates new child subscription with given subscriber and/or transducer and optional subscription ID.
Parameters
- sub: Partial<ISubscriber>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, B>
Implementation of ISubscribable.subscribe
Inherited from Subscription.subscribe
- Defined in rstream/src/subscription.ts:137
Type parameters
- C
Parameters
- sub: Subscription<B, C>
Returns Subscription<B, C>
Implementation of ISubscribable.subscribe
Inherited from Subscription.subscribe
- Defined in rstream/src/subscription.ts:138
Type parameters
- C
Parameters
- xform: Transducer<B, C>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, C>
Implementation of ISubscribable.subscribe
Inherited from Subscription.subscribe
- Defined in rstream/src/subscription.ts:142
Type parameters
- C
Parameters
- sub: Partial<ISubscriber<C>>
- xform: Transducer<B, C>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, C>

subscribeAll

subscribeAll(...subs: ISubscriber[]): Subscription<B, B>[]

Inherited from Subscription.subscribeAll
- Defined in rstream/src/subscription.ts:187
Returns array of new child subscriptions for all given subscribers.
Parameters
- Rest ...subs: ISubscriber[]
 -
Returns Subscription<B, B>[]

transform

transform<C>(a: Transducer<B, C>, opts?: Partial<CommonOpts>): Subscription<B, C>
transform<C, D>(a: Transducer<B, C>, b: Transducer<C, D>, opts?: Partial<CommonOpts>): Subscription<B, D>
transform<C, D, E>(a: Transducer<B, C>, b: Transducer<C, D>, c: Transducer<D, E>, opts?: Partial<CommonOpts>): Subscription<B, E>
transform<C, D, E, F>(a: Transducer<B, C>, b: Transducer<C, D>, c: Transducer<D, E>, d: Transducer<E, F>, opts?: Partial<CommonOpts>): Subscription<B, F>

Implementation of ITransformable.transform
Inherited from Subscription.transform
- Defined in rstream/src/subscription.ts:203
Creates a new child subscription using given transducers and optional subscription ID. Supports up to 4 transducers and if more than one transducer is given, composes them in left-to-right order using {@link @thi.ng/transducers#(comp:1)}.
Shorthand for subscribe(comp(xf1, xf2,...), id)
Type parameters
- C
Parameters
- a: Transducer<B, C>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, C>
Implementation of ITransformable.transform
Inherited from Subscription.transform
- Defined in rstream/src/subscription.ts:208
Type parameters
- C
- D
Parameters
- a: Transducer<B, C>
- b: Transducer<C, D>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, D>
Implementation of ITransformable.transform
Inherited from Subscription.transform
- Defined in rstream/src/subscription.ts:210
Type parameters
- C
- D
- E
Parameters
- a: Transducer<B, C>
- b: Transducer<C, D>
- c: Transducer<D, E>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, E>
Implementation of ITransformable.transform
Inherited from Subscription.transform
- Defined in rstream/src/subscription.ts:212
Type parameters
- C
- D
- E
- F
Parameters
- a: Transducer<B, C>
- b: Transducer<C, D>
- c: Transducer<D, E>
- d: Transducer<E, F>
- Optional opts: Partial<CommonOpts>
Returns Subscription<B, F>

unsubscribe

unsubscribe(sub?: Subscription<B, any>): boolean

Implementation of ISubscribable.unsubscribe
Overrides Subscription.unsubscribe
- Defined in rstream/src/metastream.ts:159
Parameters
- Optional sub: Subscription<B, any>
Returns boolean

Type parameters

A

B

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

factory: Fn<A, Subscription<B, B>>

Default value opts: Partial<MetaStreamOpts> = {}

Returns MetaStream

Properties

Protected cacheLast

closeIn

closeOut

doneRequested

emitLast

factory

id

Protected last

Protected Optional parent

Protected state

Optional stream

Optional sub

Protected subs

Protected Optional xform

Methods

Protected addWrapped

Parameters

wrapped: Subscription<any, any>

Returns Subscription<any, any>

Protected cleanup

Returns void

deref

Returns B | undefined

Protected detach

Parameters

force: boolean

Returns void

Protected dispatch

Parameters

x: B

Returns void

done

Returns void

Protected ensureState

Returns void

error

Parameters

e: any

Returns void

getState

Returns State

map

Type parameters

C

Parameters

fn: Fn<B, C>

Returns Subscription<B, C>

next

Parameters

x: A

Returns void

subscribe

Parameters

sub: Partial<ISubscriber<B>>

Optional opts: Partial<CommonOpts>

Returns Subscription<B, B>

Type parameters

C

Parameters

sub: Subscription<B, C>

Returns Subscription<B, C>

Type parameters

C

Parameters