Class Stream

Hierarchy

Stream

Index

Constructors

Methods

cachedObservable createEventStream createResultStream normalizeMatchTypes normalizeOperations normalizeReconnects normalizeSortedSet parseOptions resolveObject streamObservable

Constructors

constructor

new Stream(): Stream
Returns Stream

Methods

`Static` cachedObservable

cachedObservable<T>(observable: Observable<T>, options: JsonMap): Observable<T>
Type Parameters
- T
Parameters
- observable: Observable<T>
- options: JsonMap
Returns Observable<T>
- Defined in lib/query/Stream.ts:216

`Static` createEventStream

createEventStream<T>(entityManager: EntityManager, query: JsonMap, options?: EventStreamOptions): Observable<RealtimeEvent<T>>
Creates a live updating object stream for a query

Returns
The query result as a live updating stream of objects
Type Parameters
- T extends Entity<T>
Parameters
- entityManager: EntityManager
  
  The owning entity manager of this query
- query: JsonMap
  
  The query options
- Optional options: EventStreamOptions
  
  an object containing parameters
Returns Observable<RealtimeEvent<T>>
- Defined in lib/query/Stream.ts:85

`Static` createResultStream

createResultStream<T>(entityManager: EntityManager, query: JsonMap, options?: ResultStreamOptions): Observable<T[]>
Creates a live updating result stream for a query

Alias
query.Stream.createStreamResult

Returns
The query result as a live updating query result
Type Parameters
- T extends Entity<T>
Parameters
- entityManager: EntityManager
  
  The owning entity manager of this query
- query: JsonMap
  
  The query options
- Optional options: ResultStreamOptions
  
  an object containing parameters
Returns Observable<T[]>
- Defined in lib/query/Stream.ts:131

`Static` normalizeMatchTypes

normalizeMatchTypes(list: undefined | string | string[]): string[]
Parameters
- list: undefined | string | string[]
Returns string[]
- Defined in lib/query/Stream.ts:282

`Static` normalizeOperations

normalizeOperations(list: undefined | string | string[]): string[]
Parameters
- list: undefined | string | string[]
Returns string[]
- Defined in lib/query/Stream.ts:293

`Static` normalizeReconnects

normalizeReconnects(reconnects: undefined | string | number): number
Parameters
- reconnects: undefined | string | number
Returns number
- Defined in lib/query/Stream.ts:286

`Static` normalizeSortedSet

normalizeSortedSet(list: undefined | string | string[], wildcard: string, itemType: string, allowedItems: string[]): string[]
Parameters
- list: undefined | string | string[]
- wildcard: string
- itemType: string
- allowedItems: string[]
Returns string[]
- Defined in lib/query/Stream.ts:297

`Static` parseOptions

parseOptions(options?: EventStreamOptions): JsonMap
Parses the StreamOptions

Returns
an object containing VALID options
Parameters
- Optional options: EventStreamOptions
  
  object containing partial options
Returns JsonMap
- Defined in lib/query/Stream.ts:265

`Static` resolveObject

resolveObject<T>(entityManager: EntityManager, object: JsonMap): T
Type Parameters
- T extends Entity<T>
Parameters
- entityManager: EntityManager
- object: JsonMap
Returns T
- Defined in lib/query/Stream.ts:333

`Static` streamObservable

streamObservable<R>(entityManager: EntityManager, query: JsonMap, options: EventStreamOptions, mapper: ((event: BaseEvent, next: ((result: R) => any)) => any)): Observable<R>
Type Parameters
- R
Parameters
- entityManager: EntityManager
- query: JsonMap
- options: EventStreamOptions
- mapper: ((event: BaseEvent, next: ((result: R) => any)) => any)
  - - (event: BaseEvent, next: ((result: R) => any)): any
    - Parameters
      
      event: BaseEvent
      
      next: ((result: R) => any)
      
      (result: R): any
      
      Parameters
      
      result: R
      
      Returns any
      
      Returns any
Returns Observable<R>
- Defined in lib/query/Stream.ts:173

Class Stream

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Stream

Methods

Static cachedObservable

Type Parameters

T

Parameters

observable: Observable<T>

options: JsonMap

Returns Observable<T>

Static createEventStream

Returns

Type Parameters

T extends Entity<T>

Parameters

entityManager: EntityManager

query: JsonMap

Optional options: EventStreamOptions

Returns Observable<RealtimeEvent<T>>

Static createResultStream

Alias

Returns

Type Parameters

T extends Entity<T>

Parameters

entityManager: EntityManager

query: JsonMap

Optional options: ResultStreamOptions

Returns Observable<T[]>

Static normalizeMatchTypes

Parameters

list: undefined | string | string[]

Returns string[]

Static normalizeOperations

Parameters

list: undefined | string | string[]

Returns string[]

Static normalizeReconnects

Parameters

reconnects: undefined | string | number

Returns number

Static normalizeSortedSet

Parameters

list: undefined | string | string[]

wildcard: string

itemType: string

allowedItems: string[]

Returns string[]

Static parseOptions

Returns

Parameters

Optional options: EventStreamOptions

Returns JsonMap

Static resolveObject

Type Parameters

T extends Entity<T>

Parameters

entityManager: EntityManager

object: JsonMap

Returns T

Static streamObservable

Type Parameters

R

Parameters

entityManager: EntityManager

query: JsonMap

options: EventStreamOptions

mapper: ((event: BaseEvent, next: ((result: R) => any)) => any)

Parameters

event: BaseEvent

next: ((result: R) => any)

Parameters

result: R

Returns any

`Static` cachedObservable

`Static` createEventStream

`Optional` options: EventStreamOptions

`Static` createResultStream

`Optional` options: ResultStreamOptions

`Static` normalizeMatchTypes

`Static` normalizeOperations

`Static` normalizeReconnects

`Static` normalizeSortedSet

`Static` parseOptions

`Optional` options: EventStreamOptions

`Static` resolveObject

`Static` streamObservable