Interface MutateStream<T, E, S>

MutateStream allows mutating services to send back success or failure events to requesting actors.

Type parameters

T = any
E = any
S = any

Hierarchy

StoreStream<T, E>
- MutateStream

Implemented by

MutateStreamImpl

Index

Methods

Methods

error

error(error: E): void

- Defined in src/store.api.ts:49
Something went wrong with mutation

Parameters
- error: E
  
  value to pass back to the mutator
Returns void

subscribe

subscribe(successHandler: MessageFunction<T>): Subscription

Inherited from StoreStream.subscribe
- Defined in src/store.api.ts:20
Subscribe to Observable stream.

Parameters
- successHandler: MessageFunction<T>
  
  function to handle ticks on stream
Returns Subscription
subscription to stream.

success

success(success: S): void

- Defined in src/store.api.ts:55
The mutation was a success!

Parameters
- success: S
  
  value to pass back to mutator
Returns void

unsubscribe

unsubscribe(): void

Inherited from StoreStream.unsubscribe
- Defined in src/store.api.ts:25
Unsubscribe from Observable stream.

Returns void

Generated using TypeDoc