Description
neojax is a lightweight alternative to axios, with native typescript support.
Setup
npm
npm install neojax --save
cdn
Documentation
To import in the module do:
;
With typescript you can as well import the different types
;
This will give you a new Neojax instance, without any preset options.
If you want to predefine the baseUrl or headers you can create a new instance from this object, with the create() method.
const neojax = Neojax;
To send out a basic get request:
Neojax ;
You can also use async/await, because it returns a Promise.
const response = await Neojax;
This works similarly in typescript:
Neojax.geturl, options .then .catch;
And with async/await it looks like the following:
;
A post request looks similar, with the main difference, that you have an optional data parameter.
const response = await Neojax;
It is now possible to change global defaults. (As well as those defined in your instance).
// globalNeojax.options.headers = 'application/json; charset=utf-8'; // for instancesneojax.options.baseUrl = 'https://api.example.org/';
The currently supported request types are:
- GET
- POST
- PUT
- DELETE
Contribute
If you want to contribute to this project please make sure to follow our guidelines.
- You need to use tabs for indentation.
- Explain your changes in the description of your pull request.
- You may build the package locally, but you don't have to commit it, as this is done automatically.
Other than that, feel free to support neojax!