mirror of
https://github.com/hcengineering/platform.git
synced 2024-12-20 01:21:55 +03:00
34 lines
836 B
Markdown
34 lines
836 B
Markdown
# Overview
|
|
|
|
Package allow to create a client to interact with running platform.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import clientResources from '@hcengineering/client-resources'
|
|
import core, { Client } from '@hcengineering/core'
|
|
|
|
// ...
|
|
|
|
const token = ... // Token obtained somehow.
|
|
|
|
const connection: Client = await (await clientResources()).function.GetClient(token, transactorUrl)
|
|
|
|
// Now client is usable
|
|
|
|
// Use close, to shutdown connection.
|
|
await connection.close()
|
|
```
|
|
|
|
## Node JS
|
|
|
|
For NodeJS environment it is required to configure ClientSocketFactory using 'ws' package.
|
|
|
|
```ts
|
|
// We need to override default WebSocket factory with 'ws' one.
|
|
setMetadata(client.metadata.ClientSocketFactory, (url) => new WebSocket(url))
|
|
|
|
const connection: Client = await (await clientResources()).function.GetClient(token, transactorUrl)
|
|
...
|
|
```
|