# @ackee/antonio-auth

> ![ackee|Antonio](/assets/ackee_git_frontend_antonio.png)

Latest version **5.0.3** (published 2025-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ackee/antonio-auth
pnpm add @ackee/antonio-auth
yarn add @ackee/antonio-auth
bun add @ackee/antonio-auth
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.3 |
| Published | 2025-04-22 |
| First published | 2021-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 1 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Jiří Čermák |
| Maintainers | ackeecz, horaklukas, borecekbaji, davidbilik, grissius, hofp37, pivl |
| Keywords | ackee, http-client, javascript, fetch |

## Links

- npm: https://www.npmjs.com/package/@ackee/antonio-auth
- Repository: https://github.com/AckeeCZ/antonio
- Homepage: https://github.com/AckeeCZ/antonio#readme
- Issues: https://github.com/AckeeCZ/antonio/issues
- npm.io page: https://npm.io/package/@ackee/antonio-auth

## Dependencies (1)

- [@ackee/antonio-utils](https://npm.io/package/@ackee/antonio-utils.md) ^5.0.3

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 5.0.3 (latest) — 2025-04-22
- 4.0.2 (@ackee/antonio-auth) — 2021-09-10
- 4.0.0-beta.39 (beta) — 2021-09-10
- 5.0.2 — 2025-04-22
- 5.0.1 — 2025-04-04
- 5.0.0 — 2024-03-08
- 4.1.1 — 2023-09-29
- 4.0.14 — 2023-02-22
- 4.0.13 — 2023-02-22
- 4.0.12 — 2022-06-28
- 4.0.11 — 2021-11-25
- 4.0.10 — 2021-10-25
- 4.0.9 — 2021-10-20
- 4.0.8 — 2021-10-19
- 4.0.7 — 2021-10-19
- … 19 more at https://npm.io/package/@ackee/antonio-auth/versions

## README

![ackee|Antonio](/assets/ackee_git_frontend_antonio.png)

# [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AckeeCZ/antonio/blob/master/LICENSE) [![CI Status](https://img.shields.io/travis/com/AckeeCZ/antonio.svg?style=flat)](https://travis-ci.com/AckeeCZ/antonio) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request) [![Dependency Status](https://img.shields.io/david/AckeeCZ/antonio.svg?style=flat-square)](https://david-dm.org/AckeeCZ/antonio) [![bundlephobia](https://flat.badgen.net/bundlephobia/min/@ackee/antonio-auth)](https://bundlephobia.com/result?p=@ackee/antonio-auth) [![bundlephobia](https://flat.badgen.net/bundlephobia/minzip/@ackee/antonio-auth)](https://bundlephobia.com/result?p=@ackee/antonio-auth) ![node version](https://img.shields.io/node/v/@ackee/antonio-auth) ![@ackee/petrus min required version](https://img.shields.io/npm/dependency-version/@ackee/antonio-auth/peer/@ackee/petrus)

# `@ackee/antonio-auth`

It includes a request interceptor for `@ackee/antonio-core` that sets the `Authorization` header with an access token obtained from `getAccessToken` from `@ackee/petrus`.

## Table of contents

-   [Install](#install)
-   [API](#api)
-   [API (TypeDoc)](./docs)

## Install

```bash
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`

A request interceptor that sets the `Authorization` header with `setAuthHeader` from `@ackee/antonio-utils` and obtained from `getAccessToken` from `@ackee/petrus`.

#### Default usage example

```js
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)

```js
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;
});
```

---
_Source: https://npm.io/package/@ackee/antonio-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._