# koa-auto-transfer-header

> auto transfer header in each http-request when server receive a request

Latest version **1.3.4** (published 2025-08-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-auto-transfer-header
pnpm add koa-auto-transfer-header
yarn add koa-auto-transfer-header
bun add koa-auto-transfer-header
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.4 |
| Published | 2025-08-15 |
| First published | 2022-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.17.0 |
| Dependencies | 0 |
| Unpacked size | 31.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | tunan |
| Maintainers | xuezi |
| Keywords | koa, transfer, trace |

## Links

- npm: https://www.npmjs.com/package/koa-auto-transfer-header
- Repository: https://github.com/xuezier/koa-auto-transfer-header
- Homepage: https://github.com/xuezier/koa-auto-transfer-header#readme
- Issues: https://github.com/xuezier/koa-auto-transfer-header/issues
- npm.io page: https://npm.io/package/koa-auto-transfer-header

## Recent versions

- 1.3.4 (latest) — 2025-08-15
- 1.3.3 — 2025-08-07
- 1.3.2 — 2024-12-18
- 1.3.1 — 2024-07-18
- 1.3.0 — 2024-07-18
- 1.2.4 — 2024-05-27
- 1.2.3 — 2024-05-27
- 1.2.2 — 2024-05-27
- 1.2.1 — 2024-05-27
- 1.2.0 — 2024-05-27
- 1.1.3 — 2024-04-08
- 1.1.2 — 2024-03-05
- 1.1.1 — 2024-03-05
- 1.1.0 — 2024-03-05
- 1.0.6 — 2023-08-23
- … 6 more at https://npm.io/package/koa-auto-transfer-header/versions

## README

# koa-auto-transfer-header

In a Koa server, when a client request is received and an external HTTP request is initiated in the request, the request header initiated by the client is automatically forwarded.

Also used in a server started from any Web Framework.

Support all `http-client` libs based on `http` module.

## Installation

```bash
npm install koa-auto-transfer-header [--save]
or
yarn add koa-auto-transfer-header
```

## Usage

import in portal file

```typescript
import 'koa-auto-transfer-header';
```

### Config

```typescript
interface IConfig {
	enable: boolean;		// is enable tranfer, default: true
	transferHeaders: string[],	// transfer header keys, default: ['request-id', 'trace-id']
}
```

disable transfer

```typescript
import { disableTransferHeaders } from 'koa-auto-transfer-header';

disableTransferHeaders();
```

add transfer header

```typescript
import { addTransferHeader } from 'koa-auto-transfer-header';

addTransferHeader('my-header');
```

reset transfer headers

```typescript
import { setTransferHeaders } from 'koa-auto-transfer-header';

setTransferHeaders(['my-header1', 'my-header2']);
```

add request headers hook

```typescript
import { RequestHeadersHook } from 'koa-auto-transfer-header';

const foo = () => {
	return { 'x-headers-foo': '123' }
}
const bar = () => {
	return { 'x-headers-bar': '123' }
}
RequestHeadersHook.register(foo)
RequestHeadersHook.register(bar)

// cancel the register
RequestHeadersHook.unregister(foo)
```

---
_Source: https://npm.io/package/koa-auto-transfer-header · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._