platform/plugins/client-resources
Andrey Sobolev bc5f9c0631
Server Backup Client interface (#1813)
Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
2022-05-23 22:53:33 +07:00
..
config
src Server Backup Client interface (#1813) 2022-05-23 22:53:33 +07:00
.eslintrc.js
.npmignore
CHANGELOG.json
CHANGELOG.md
package.json CI formatting (#1590) 2022-04-29 12:27:17 +07:00
readme.md
tsconfig.json

Overview

Package allow to create a client to interact with running platform.

Usage

  import clientResources from '@anticrm/client-resources'
  import core, { Client } from '@anticrm/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 enviornment 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)
...