https://github.com/techcell-project/node-sdk
A generated SDK for Nodejs
https://github.com/techcell-project/node-sdk
Last synced: 5 months ago
JSON representation
A generated SDK for Nodejs
- Host: GitHub
- URL: https://github.com/techcell-project/node-sdk
- Owner: TechCell-Project
- Created: 2024-04-06T18:25:42.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T18:21:20.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T08:51:28.742Z (almost 2 years ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@techcell/node-sdk
- Size: 33.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## @techcell/node-sdk@latest
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 @techcell/node-sdk@latest --save
```
_unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```
TechCell Server Node SDK autogenerated by [TechCellServer@aa25203](https://github.com/TechCell-Project/the-next-server/commit/aa25203)