@ackee/antonio-auth 中文文档教程

Question

@ackee/antonio-auth

它包含一个用于设置 Authorization 的 @ackee/antonio-core 的请求拦截器带有从 @ackee/petrus 的 getAccessToken 获得的访问令牌的标头。

Table of contents

• Install
• API
• API (TypeDoc)

Install

yarn add @ackee/antonio-auth -S

# Check you have installed at least these dependencies' versions:
yarn add @ackee/petrus@5.2.1

API

requestAuthHeaderInterceptor(request: Request): Request

一个请求拦截器，它使用 @ackee/antonio-utils 中的 setAuthHeader 设置 Authorization 标头，并从 getAccessToken 中获取<代码>@ackee/petrus。

Default usage example

import { Antonio } from '@ackee/antonio-core';
import { requestAuthHeaderInterceptor } from '@ackee/antonio-auth';

const api = new Antonio({
    baseURL: '...',
});

api.interceptors.request.use(null, requestAuthHeaderInterceptor);

Custom usage example (without @ackee/petrus)

import { Antonio } from '@ackee/antonio-core';
import { setAuthHeader } from '@ackee/antonio-utils';

const api = new Antonio({
    baseURL: '...',
});

function* getAccessToken() {
    // Your custom function for obtaining the access token.
}

api.interceptors.request.use(null, function* (request) {
    const accessToken = yield getAccessToken();

    setAuthHeader(requst.headers, accessToken);

    return request;
});