https://github.com/mearman/openalex-typescript-fetch
https://github.com/mearman/openalex-typescript-fetch
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mearman/openalex-typescript-fetch
- Owner: Mearman
- Created: 2024-01-14T20:53:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-04T05:14:14.000Z (11 months ago)
- Last Synced: 2025-02-28T13:15:59.575Z (3 months ago)
- Language: TypeScript
- Size: 29.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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 [email protected] --save
```
_unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```