Class Stream

Hierarchy

Model
- Stream

Indexable

[x: string]: any

Constructors

constructor

new Stream(service?: string, startWatchdog?: boolean): Stream
Parameters
- Optionalservice: string
- startWatchdog: boolean = true
Returns Stream
Overrides Model.constructor
- Defined in src/models/stream.ts:80

Properties

expand

expand: number

meta

meta: Meta = ...

`Optional`parent

parent?: IModel

websocketService

websocketService: string = ''

websocketUrl

websocketUrl: string = ''

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/stream'

Methods

_create

_create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from Model._create
- Defined in src/models/model.ts:110

addChildrenToStore

addChildrenToStore(): void
Returns void
Inherited from Model.addChildrenToStore
- Defined in src/models/model.ts:73

cancelRequest

cancelRequest(handler: RequestHandler, internal: boolean): Promise<boolean>
Parameters
- handler: RequestHandler
- internal: boolean
Returns Promise<boolean>
- Defined in src/models/stream.ts:588

close

close(): void
Returns void
- Defined in src/models/stream.ts:180

create

create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from Model.create
- Defined in src/models/model.ts:143

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from Model.delete
- Defined in src/models/model.ts:239

getAttributes

getAttributes(): string[]
Returns string[]
Inherited from Model.getAttributes
- Defined in src/models/model.ts:69

getClass

getClass(): string
Returns string
Inherited from Model.getClass
- Defined in src/models/model.ts:57

getParent

getParent(): undefined | IModel
Returns undefined | IModel
Inherited from Model.getParent
- Defined in src/models/model.ts:82

getType

getType(): string
Returns string
Inherited from Model.getType
- Defined in src/models/model.ts:41

getUrl

getUrl(): string
Returns string
Inherited from Model.getUrl
- Defined in src/models/model.ts:101

getVersion

getVersion(): string
Returns string
Inherited from Model.getVersion
- Defined in src/models/model.ts:45

id

id(): string
Returns string
Inherited from Model.id
- Defined in src/models/model.ts:37

loadAllChildren

loadAllChildren(json: null | JSONObject, reloadAll?: boolean): Promise<void>
Parameters
- json: null | JSONObject
- reloadAll: boolean = false
Returns Promise<void>
Inherited from Model.loadAllChildren
- Defined in src/models/model.ts:198

onRequest

onRequest(handler: RequestHandler, internal: boolean): Promise<boolean>
Parameters
- handler: RequestHandler
- internal: boolean
Returns Promise<boolean>
- Defined in src/models/stream.ts:569

parse

parse(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Inherited from Model.parse
- Defined in src/models/model.ts:252

parseChild

parseChild(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Inherited from Model.parseChild
- Defined in src/models/model.ts:267

path

path(): string
Returns string
Inherited from Model.path
- Defined in src/models/model.ts:53

preserve

preserve(): void
Returns void
Inherited from Model.preserve
- Defined in src/models/model.ts:87

reload

reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Inherited from Model.reload
- Defined in src/models/model.ts:226

reloadAndParse

reloadAndParse(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Inherited from Model.reloadAndParse
- Defined in src/models/model.ts:205

removeChild

removeChild(_: IModel): void
Parameters
- _: IModel
Returns void
Inherited from Model.removeChild
- Defined in src/models/model.ts:66

reset

reset(): void
Returns void
- Defined in src/models/stream.ts:105

restore

restore(): void
Returns void
Inherited from Model.restore
- Defined in src/models/model.ts:90

sendEvent

sendEvent(type: string, msg: JSONValue): Promise<JSONValue>
Parameters
- type: string
- msg: JSONValue
Returns Promise<JSONValue>
- Defined in src/models/stream.ts:385

sendRequest

sendRequest(msg: JSONValue): Promise<JSONValue>
Parameters
- msg: JSONValue
Returns Promise<JSONValue>
- Defined in src/models/stream.ts:408

setParent

setParent(parent?: IModel): void
Parameters
- Optionalparent: IModel
Returns void
Inherited from Model.setParent
- Defined in src/models/model.ts:77

subscribe

subscribe(model: IStreamModel, full?: boolean): Promise<boolean>
Parameters
- model: IStreamModel
- full: boolean = false
Returns Promise<boolean>
- Defined in src/models/stream.ts:222

subscribeEvent

subscribeEvent(service: string, handler: StreamHandler): Promise<boolean>
Parameters
- service: string
- handler: StreamHandler
Returns Promise<boolean>
- Defined in src/models/stream.ts:333

subscribeInternal

subscribeInternal(type: string, handler: RequestHandler): Promise<boolean>
Parameters
- type: string
- handler: RequestHandler
Returns Promise<boolean>
- Defined in src/models/stream.ts:253

subscribeService

subscribeService(
    service: string,
    handler: ServiceHandler,
    full?: boolean,
): Promise<boolean>
Parameters
- service: string
- handler: ServiceHandler
- full: boolean = false
Returns Promise<boolean>
- Defined in src/models/stream.ts:287

toJSON

toJSON(customKeys?: string[]): JSONObject
Parameters
- OptionalcustomKeys: string[]
Returns JSONObject
Inherited from Model.toJSON
- Defined in src/models/model.ts:271

unsubscribe

unsubscribe(model: IStreamModel): Promise<boolean>
Parameters
- model: IStreamModel
Returns Promise<boolean>
- Defined in src/models/stream.ts:240

unsubscribeEvent

unsubscribeEvent(service: string, handler: StreamHandler): Promise<boolean>
Parameters
- service: string
- handler: StreamHandler
Returns Promise<boolean>
- Defined in src/models/stream.ts:351

unsubscribeService

unsubscribeService(
    service: string,
    handler: ServiceHandler,
    full?: boolean,
): Promise<boolean>
Parameters
- service: string
- handler: ServiceHandler
- full: boolean = false
Returns Promise<boolean>
- Defined in src/models/stream.ts:306

update

update(customKeys?: string[]): Promise<boolean>
Parameters
- OptionalcustomKeys: string[]
Returns Promise<boolean>
Inherited from Model.update
- Defined in src/models/model.ts:179

url

url(): string
Returns string
Inherited from Model.url
- Defined in src/models/model.ts:49

`Protected`usePutForUpdate

usePutForUpdate(): boolean
Returns boolean
Inherited from Model.usePutForUpdate
- Defined in src/models/model.ts:61

`Protected`validate

validate(name: string, params: any): void
Parameters
- name: string
- params: any
Returns void
Inherited from Model.validate
- Defined in src/models/model.ts:97

`Static`fetch

fetch(params: FetchRequest): Promise<JSONObject[]>
Parameters
- params: FetchRequest
Returns Promise<JSONObject[]>
Inherited from Model.fetch
- Defined in src/models/model.ts:297

`Static`fromArray

fromArray<T>(
    this: new () => T,
    json: JSONObject[],
    parent?: IModel,
): (string | T)[]
Type Parameters
- T
Parameters
- this: new () => T
- json: JSONObject[]
- Optionalparent: IModel
Returns (string | T)[]
Inherited from Model.fromArray
- Defined in src/models/model.ts:336

`Protected` `Static`generateOptions

generateOptions(params?: JSONObject): JSONObject
Parameters
- Optionalparams: JSONObject
Returns JSONObject
Inherited from Model.generateOptions
- Defined in src/models/model.ts:384

`Static`getMetaFilterResult

getMetaFilterResult(_filter?: Filter): string
Parameters
- Optional_filter: Filter
Returns string
Inherited from Model.getMetaFilterResult
- Defined in src/models/model.ts:93

`Static`validateMethod

validateMethod(
    type: undefined | string,
    name: string,
    params: any,
    isStatic?: boolean,
): void
Parameters
- type: undefined | string
- name: string
- params: any
- isStatic: boolean = false
Returns void
Inherited from Model.validateMethod
- Defined in src/models/model.ts:352