Interface ISubscribable<T>

Type parameters

T

Hierarchy

IDeref<T | undefined>
IID<string>
- ISubscribable
  - ISubscribableSubscriber

Implemented by

Index

Properties

id

Methods

Properties

Readonly id

id: string

Methods

deref

deref(): T | undefined

Inherited from ISubscribable.deref
- Defined in api/api/deref.d.ts:9
Returns wrapped value.
Returns T | undefined

getState

getState(): State

- Defined in rstream/src/api.ts:113
Returns State

subscribe

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

- Defined in rstream/src/api.ts:98
Parameters
- sub: Partial<ISubscriber<T>>
- Optional opts: Partial<CommonOpts>
Returns Subscription<T, T>
- Defined in rstream/src/api.ts:102
Type parameters
- C
Parameters
- sub: Partial<ISubscriber<T>>
- xform: Transducer<T, C>
- Optional opts: Partial<CommonOpts>
Returns Subscription<T, C>
- Defined in rstream/src/api.ts:107
Type parameters
- C
Parameters
- xform: Transducer<T, C>
- Optional opts: Partial<CommonOpts>
Returns Subscription<T, C>
- Defined in rstream/src/api.ts:111
Type parameters
- C
Parameters
- sub: Subscription<T, C>
Returns Subscription<T, C>

unsubscribe

unsubscribe(sub?: Partial<ISubscriber<T>>): boolean

- Defined in rstream/src/api.ts:112
Parameters
- Optional sub: Partial<ISubscriber<T>>
Returns boolean

Generated using TypeDoc