new Stream()
- Source:
Methods
(static) createStream(entityManager, query, options) → {Observable.<RealtimeEvent.<T>>}
Creates a live updating object stream for a query
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
entityManager |
EntityManager | The owning entity manager of this query |
|||||||||||||||||||||||||||||
query |
string | The query options |
|||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
options |
Partial.<StreamOptions> | an object containing parameters |
- Source:
Returns:
The query result as a live updating stream of objects
- Type
- Observable.<RealtimeEvent.<T>>
(static) createStreamResult(entityManager, query, options) → {Observable.<Array.<T>>}
Creates a live updating result stream for a query
Parameters:
Name | Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
entityManager |
EntityManager | The owning entity manager of this query |
|||||||||||||||||||||||||
query |
string | The query options |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
options |
Partial.<StreamOptions> | an object containing parameters |
- Source:
Returns:
The query result as a live updating query result
- Type
- Observable.<Array.<T>>
(static) parseOptions(optionsopt) → {StreamOptions}
Parses the StreamOptions
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Partial.<StreamOptions> |
<optional> |
object containing partial options |
- Source:
Returns:
an object containing VALID options
- Type
- StreamOptions