https://github.com/devflowinc/trieve-js-ts-client
https://github.com/devflowinc/trieve-js-ts-client
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devflowinc/trieve-js-ts-client
- Owner: devflowinc
- Created: 2024-03-28T16:46:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T00:21:11.000Z (about 1 year ago)
- Last Synced: 2025-06-22T05:17:06.776Z (6 months ago)
- Language: TypeScript
- Size: 551 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## @devflowinc/trieve-js-ts-client@0.11.7
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
Environment
* Node.js
* Webpack
* Browserify
Language level
* ES5 - you must have a Promises/A+ library installed
* ES6
Module system
* CommonJS
* ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```
### Publishing
First build the package then run `npm publish`
### Consuming
navigate to the folder of your consuming project and run one of the following commands.
_published:_
```
npm install @devflowinc/trieve-js-ts-client@0.8.5 --save
```
_unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```