platform/plugins/client-resources
Denis Bykhov ecf4064f69
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
Fix onConnect handler (#7265)
Signed-off-by: Denis Bykhov <bykhov.denis@gmail.com>
2024-12-05 22:29:54 +07:00
..
config :Apply templates (#3799) 2023-10-07 16:38:21 +06:00
src Fix onConnect handler (#7265) 2024-12-05 22:29:54 +07:00
.eslintrc.js :Apply templates (#3799) 2023-10-07 16:38:21 +06:00
.npmignore initial client-resources implementation 2021-08-07 06:30:10 +02:00
CHANGELOG.json Migrate to hcengineering and publish to github packages (#2273) 2022-09-21 14:08:25 +06:00
CHANGELOG.md Migrate to hcengineering and publish to github packages (#2273) 2022-09-21 14:08:25 +06:00
jest.config.js :Apply templates (#3799) 2023-10-07 16:38:21 +06:00
package.json Bump package versions (#5728) 2024-06-05 12:46:40 +07:00
readme.md TSK-825: Client proper reconnection (#2797) 2023-03-24 10:53:12 +06:00
tsconfig.json Fix validate build (#4780) 2024-02-27 15:29:41 +07:00

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)
...