Class ClientFactory

Hierarchy

ClientFactory

Index

Constructors

Methods

close create createXmlHttpRequest getTask initWebSocket registerTask removeTask setFetchOptionsInterceptor setXmlHttpRequestInterceptor

Constructors

constructor

new ClientFactory(address: string, settings?: ClientFactorySettings): ClientFactory
Parameters
- address: string
- Optional settings: ClientFactorySettings
Returns ClientFactory
- Defined in BackplaneJsClient/jsclient.d.ts:28

Methods

close

close(): void
Returns void
- Defined in BackplaneJsClient/jsclient.d.ts:34

create

create(settings?: ClientFactorySettings): Promise<Client>
Parameters
- Optional settings: ClientFactorySettings
Returns Promise<Client>
- Defined in BackplaneJsClient/jsclient.d.ts:32

createXmlHttpRequest

createXmlHttpRequest(): XMLHttpRequest
Returns XMLHttpRequest
- Defined in BackplaneJsClient/jsclient.d.ts:31

getTask

getTask(id: string, name: string, nodeId: unknown): Task
Parameters
- id: string
- name: string
- nodeId: unknown
Returns Task
- Defined in BackplaneJsClient/jsclient.d.ts:37

`Private` initWebSocket

initWebSocket(): Promise<unknown>
Returns Promise<unknown>
- Defined in BackplaneJsClient/jsclient.d.ts:33

registerTask

registerTask(task: Task): void
Parameters
- task: Task
Returns void
- Defined in BackplaneJsClient/jsclient.d.ts:36

removeTask

removeTask(task: Pick<Task, "id">): void
Parameters
- task: Pick<Task, "id">
Returns void
- Defined in BackplaneJsClient/jsclient.d.ts:38

setFetchOptionsInterceptor

setFetchOptionsInterceptor(fetchOptionsInterceptor: unknown): void
Parameters
- fetchOptionsInterceptor: unknown
Returns void
- Defined in BackplaneJsClient/jsclient.d.ts:30

setXmlHttpRequestInterceptor

setXmlHttpRequestInterceptor(xmlHttpRequestCreationInterceptor: unknown): void
Parameters
- xmlHttpRequestCreationInterceptor: unknown
Returns void
- Defined in BackplaneJsClient/jsclient.d.ts:29

Generated using TypeDoc