A wrapper around (Red)axios in combination with Json Web Token Handling to easily communicate with an API, with or without authorization.
MIT License
TS-API-Toolkit is a simple way to handle your API calls as well as your localStorage JWT management. The library offers a simple wrapper around redaxios in conjunction with a service to handle your JWTs. No longer will you need to attach tokens to every request or even manually worry about them. Just set the token, and it'll be attached to every call you make.
$ yarn add ts-api-toolkit
import apiToolkit from 'ts-api-toolkit';
const { data: { user } } = await apiToolkit.post('users/login', credentials);
authStorageService.saveToken(user.token);
This library offers two class instance exports, ApiSerivce
and AuthStorageService
. Using these you can easily handle your application.
Provides an instance of AuthStorageService.
Changes the key your token is stored under in localStorage.
The token key is what identifies your token as it is saved in a browser's localStorage. The value from that key is attached to every API request.
Retrieves the current value for your token key. If a value cannot be found, returns an empty string.
Saves a provided token into localStorage using the tokenKey.
The token you save will be used with all future API requests, until it is removed or changed.
Removes the currently stored token key and value.
Provides an instance of ApiService.
Changes the base URL to use when making requests.
Use the baseUrl
parameter to describe your base API URL. Use a partial route like /api
if you want to use a proxy, otherwise, set the full route to your API like http://example.com/api
. The default baseUrl
is /api/v1
.
Changes the scheme used in the Authorization header.
Use the authSchema
parameter to describe the prefix to the token. The default is set to Bearer
, so, unedited, all API requests will come with the following header: Authorization: 'Bearer <auth-token>'
GET request
POST request
PUT request
PATCH request
DELETE request
OPTIONS request
All requests use the Authorization header to send the current token in localStorage, regardless of whether it is empty.
Query parameters will all be properly serialized, no need to provide anything beyond an object.
`{ name: 'ferret', color: 'purple' }` -> `?name=ferret&color=purple`
MIT © Ryan Christian