Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethern-myth/em-interceptor
em-interceptor is a lightweight package designed to simplify authentication token management in JavaScript and TypeScript applications that utilize the Axios HTTP client.
https://github.com/ethern-myth/em-interceptor
axios interceptor javascript middleware typescript
Last synced: about 1 month ago
JSON representation
em-interceptor is a lightweight package designed to simplify authentication token management in JavaScript and TypeScript applications that utilize the Axios HTTP client.
- Host: GitHub
- URL: https://github.com/ethern-myth/em-interceptor
- Owner: Ethern-Myth
- License: mit
- Created: 2024-03-09T15:00:05.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-13T18:59:04.000Z (10 months ago)
- Last Synced: 2024-12-02T09:05:44.525Z (about 1 month ago)
- Topics: axios, interceptor, javascript, middleware, typescript
- Language: TypeScript
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Interceptor for Token Management
[](https://www.npmjs.com/packageem-interceptor)
This module provides an Axios interceptor for handling authentication tokens in JavaScript and TypeScript applications. The interceptor automatically attaches authentication tokens to outgoing requests and refreshes them when necessary to ensure seamless user authentication.
## Features
- Automatically adds an Authorization header with a bearer token to outgoing requests.
- Handles token refresh logic to keep users authenticated, even if their token expires.
- Supports multiple storage options for tokens: localStorage, sessionStorage, and cookies.
## Installation
You can install the module via npm or yarn or pnpm:
```bash
npm install em-interceptor
```
or
```bash
yarn add em-interceptor
```
or
```bash
pnpm install em-interceptor
```
### InterceptorOptions API
```typescript
interface InterceptorOptions {
storageType: "localStorage" | "sessionStorage" | "cookies";
tokenKey: string;
}
```
- `storageType`: Specifies the type of storage to use for storing tokens. Options are "localStorage", "sessionStorage", or "cookies".
- `tokenKey`: Specifies the key under which the token is stored in the chosen storage type.
## Usage
1. Import the `Interceptor` function from the module `(typescript)`:
```typescript
import Interceptor, { InterceptorOptions } from "em-interceptor";
```
2. Configure the interceptor by passing an `InterceptorOptions` object:
```typescript
const options: InterceptorOptions = {
storageType: "localStorage",
tokenKey: "access_token",
};
Interceptor(options);
```
3. Use Axios as usual in your application. The interceptor will automatically handle token management for you.
## Configuration Options
- `storageType`: Specifies the type of storage to use for storing tokens. Options are "localStorage", "sessionStorage", or "cookies".
- `tokenKey`: Specifies the key under which the token is stored in the chosen storage type.
## Customization
You can customize the behavior of the interceptor by modifying the provided options or extending the interceptor functions (`requestInterceptor` and `responseInterceptor`).
### Issues and Contributions
Issues and contributions are welcome! Please feel free to open issues or submit pull requests to enhance the functionality or address any bugs.
## License
This module is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.