mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-25 00:21:07 +02:00
e2a640373e
* initial commit of generated api client * bumps lock file * changes api client dep from file link to portal in package * adds ui/api-client to copywrite config header ignore
47 lines
1.0 KiB
Markdown
47 lines
1.0 KiB
Markdown
## @hashicorp/vault-client-typescript@0.0.0
|
|
|
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). 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 @hashicorp/vault-client-typescript@0.0.0 --save
|
|
```
|
|
|
|
_unPublished (not recommended):_
|
|
|
|
```
|
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
```
|