uneeq-js 3.3.0 → 3.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/README.npm.md +0 -15
- package/README.repo.md +0 -45
package/package.json
CHANGED
package/README.npm.md
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# uneeq-js
|
|
2
|
-
|
|
3
|
-
## Installation
|
|
4
|
-
|
|
5
|
-
```bash
|
|
6
|
-
npm install uneeq-js
|
|
7
|
-
```
|
|
8
|
-
|
|
9
|
-
## Documentation
|
|
10
|
-
|
|
11
|
-
For direct SDK integration (build your own), see: https://docs.uneeq.io/unlisted
|
|
12
|
-
|
|
13
|
-
## Looking for Hosted Experience?
|
|
14
|
-
|
|
15
|
-
If you're looking for UneeQ's Hosted Experience, visit: https://docs.uneeq.io/hosted-experience
|
package/README.repo.md
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
# DHOP Web SDK
|
|
2
|
-
This project is a web npm package used to connect to Uneeq's Digital Human Orchestration Platform (DHOP)
|
|
3
|
-
|
|
4
|
-
## Usage
|
|
5
|
-
#### Install dependencies:
|
|
6
|
-
`npm i`
|
|
7
|
-
|
|
8
|
-
#### Start:
|
|
9
|
-
`npm start`
|
|
10
|
-
|
|
11
|
-
#### Run Tests:
|
|
12
|
-
`npm test`
|
|
13
|
-
|
|
14
|
-
#### Local testing
|
|
15
|
-
|
|
16
|
-
See [./example/README.md](./example/README.md)
|
|
17
|
-
|
|
18
|
-
#### Lint
|
|
19
|
-
|
|
20
|
-
Eslint is used in this project and can be run with `npm run lint`. You may find it easier to install VSCode plugin `eslint` to see lint errors in editor. Additionally adding the following option to the plugin settings will fix errors on save:
|
|
21
|
-
|
|
22
|
-
`"editor.codeActionsOnSave": {
|
|
23
|
-
"source.fixAll.eslint": true
|
|
24
|
-
}`
|
|
25
|
-
|
|
26
|
-
#### Logging
|
|
27
|
-
A custom logger has been implemented using `pino` library. You can use it to log strings with values.
|
|
28
|
-
`Logger.info('Logging just a string')`
|
|
29
|
-
`Logger.info('Logging with value', { some: 'thing' })`
|
|
30
|
-
`Logger.info('Logging with multiple values', { some: 'thing' }, { another: 'thing' })`
|
|
31
|
-
|
|
32
|
-
There are multiple log levels which are defined in `src/types/LogLevels.ts`:
|
|
33
|
-
`Logger.debug('a debug log')`
|
|
34
|
-
`Logger.info('an info log')`
|
|
35
|
-
`Logger.warn('a warning log')`
|
|
36
|
-
`Logger.error('an error log')`
|
|
37
|
-
|
|
38
|
-
Logs will only be displayed if they are at or above the log level specified when initializing the Uneeq class via UneeqConfig. The default log level is 'info'.
|
|
39
|
-
|
|
40
|
-
Log messages will be prefixed with the string 'UneeQ: ' so that uneeq-js logs can be differentiated from client logs easily.
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
## Notes
|
|
44
|
-
#### onnxruntime-web
|
|
45
|
-
onnxruntime-web only works on version 1.15.1 at this time. Upgrading this package will likely break VAD funtionality.
|