npm.io
0.1.5 • Published 2 years ago

fe-jwt-auth

Licence
MIT
Version
0.1.5
Deps
5
Size
204 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

fe-jwt-auth

FE jwt auth library

Install

$ npm i fe-jwt-auth --save

Usage

import {initService, axiosInstance, ApiService} from 'fe-jwt-auth';

initService({
    headers: {
        'x-timezone': '+07',
    },
    requestOptions: {
        baseUrl: 'http://localhost:3000/api'
    },
    events: {
        onLogout: () => {
            // handle logout
        },
        onForbidden: () => {
            // handle forbidden
        }
    }
})

// call api
const uses = await axiosInstance.get('/users')

// use ApiService
const userService = new ApiService({ baseUrl: '/user' }, axiosInstance)
const userList = userService.list()

Options

Key Default Definition
requestOptions {headers: {'Content-Type': 'application/json',},responseType: 'json'} AxiosRequestConfig
refreshTokenTimeBufferInSecond 0 Time buffer in second.
localStorageAuthService localStorageAuthServiceDefault ILocalStorageAuthService
headers Custom request header.
events Handle on logout or forbidden
refreshTokenRoute /auth/refresh-token Url path to refresh token
accessTokenKey accessToken.token key to get access token
refreshTokenKey refreshToken.token key to get refresh token
expiredTimeKey expiredTime key from JWT
ILocalStorageAuthService
Key Definition
getAccessToken () => string
setAccessToken (token: string) => void;
getRefreshToken () => string;
setRefreshToken (token: string) => void;
resetAll () => void;

Keywords

iceweblibrary