OpenAPI-generated TypeScript client for the someones.computer /api surface
- TypeScript 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .github/workflows | ||
| .openapi-generator | ||
| src | ||
| .gitignore | ||
| .npmignore | ||
| .openapi-generator-ignore | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
@someones-computer/sdk-js@1.0.0
This generator creates TypeScript/JavaScript client that utilizes Fetch API. 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)
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 @someones-computer/sdk-js@1.0.0 --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save