mirror of
https://github.com/hcengineering/platform.git
synced 2025-02-03 01:14:49 +00:00
a220fac255
Some checks are pending
CI / build (push) Waiting to run
CI / svelte-check (push) Blocked by required conditions
CI / formatting (push) Blocked by required conditions
CI / test (push) Blocked by required conditions
CI / uitest (push) Waiting to run
CI / uitest-pg (push) Waiting to run
CI / uitest-qms (push) Waiting to run
CI / docker-build (push) Blocked by required conditions
CI / dist-build (push) Blocked by required conditions
Signed-off-by: Andrey Sobolev <haiodo@gmail.com> |
||
|---|---|---|
| .. | ||
| config | ||
| src | ||
| .eslintrc.js | ||
| .npmignore | ||
| CHANGELOG.json | ||
| CHANGELOG.md | ||
| jest.config.js | ||
| package.json | ||
| readme.md | ||
| tsconfig.json | ||
Overview
Package allow to create a client to interact with running platform.
Usage
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.
// 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)
...