Interface ISubscribable<A>

interface ISubscribable<A> {
    id: string;
    deref(): undefined | A;
    subscribe<B>(sub): ISubscription<A, B>;
    subscribe(sub, opts?): ISubscription<A, A>;
    subscribe<B>(sub, opts?): ISubscription<A, B>;
    unsubscribe(sub?): boolean;
}

Type Parameters

A

Hierarchy (view full)

IDeref<A | undefined>
IID<string>
- ISubscribable
  - ISubscription

Index

Properties

Methods

deref subscribe unsubscribe

Properties

`Readonly` id

id: string

Methods

deref

deref(): undefined | A
Returns wrapped value.
Returns undefined | A
Inherited from IDeref.deref
- Defined in api/deref.d.ts:9

subscribe

subscribe<B>(sub): ISubscription<A, B>
Adds given sub as child subscription.
Type Parameters
- B
Parameters
- sub: ISubscription<A, B>
Returns ISubscription<A, B>
- Defined in rstream/src/api.ts:147
subscribe(sub, opts?): ISubscription<A, A>
Wraps given partial sub in a Subscription and attaches it as child subscription.
Parameters
- sub: Partial<ISubscriber<A>>
- Optional opts: Partial<CommonOpts>
Returns ISubscription<A, A>
- Defined in rstream/src/api.ts:155
subscribe<B>(sub, opts?): ISubscription<A, B>
Wraps given partial sub in a Subscription and attaches it as child subscription. If opts defines a transducer (via xform key), input values will be transformed first before reaching the child sub's ISubscriber.next handler. Any further downstream subscriptions attached to the returned wrapped sub will also only receive those transformed values.
Type Parameters
- B
Parameters
- sub: Partial<ISubscriber<B>>
- Optional opts: Partial<TransformableOpts<A, B>>
Returns ISubscription<A, B>
See
ITransformable
- Defined in rstream/src/api.ts:172

unsubscribe

unsubscribe(sub?): boolean
Removes given child sub, or if sub is omitted, detaches this subscription itself from its upstream parent (possibly triggering a cascade of further unsubscriptions, depending on CommonOpts.closeOut settings of parent(s)).
Parameters
- Optional sub: ISubscription<A, any>
Returns boolean
- Defined in rstream/src/api.ts:184

Generated using TypeDoc