Interface Stream<T, K, I, State>
Type parameters
T: object
K
I: string
State
Methods
off
off( type: "live" , listener: ( state: State ) => void ) : void
off( type: "change" , listener: ( state: State , events: keyof Event < T , K , I > [] ) => void ) : void
off( type: "close" , listener: ( closeEvent: StreamCloseEvent ) => void ) : void
Parameters
type: "live"
listener: ( state: State ) => void
Returns void
Parameters
type: "change"
listener: ( state: State , events: keyof Event < T , K , I > [] ) => void
( state: State , events: keyof Event < T , K , I > [] ) : void
Parameters
state: State
events: keyof Event < T , K , I > []
Returns void
Returns void
Parameters
Returns void
on
on( type: "live" , listener: ( state: State ) => void ) : void
on( type: "change" , listener: ( state: State , events: keyof Event < T , K , I > [] ) => void ) : void
on( type: "close" , listener: ( closeEvent: StreamCloseEvent ) => void ) : void
Parameters
type: "live"
listener: ( state: State ) => void
Returns void
Parameters
type: "change"
listener: ( state: State , events: keyof Event < T , K , I > [] ) => void
( state: State , events: keyof Event < T , K , I > [] ) : void
Parameters
state: State
events: keyof Event < T , K , I > []
Returns void
Returns void
Parameters
Returns void
Legend
Module Object literal Variable Function Function with type parameter Index signature Type alias Type alias with type parameter
Enumeration Enumeration member Property Method
Interface Interface with type parameter Constructor Property Method Index signature
Class Class with type parameter Constructor Property Method Accessor Index signature
Inherited constructor Inherited property Inherited method Inherited accessor
Protected property Protected method Protected accessor
Private property Private method Private accessor
Static property Static method
Interface for streams returned by the streaming methods of the
Ledgerclass. Each'change'event contains accumulated state of typeStateas well as the ledger events that triggered the current state change.