https://github.com/keq-request/keq-headers

Set/Append headers to request
https://github.com/keq-request/keq-headers

client header headers http keq middleware

Last synced: about 1 month ago
JSON representation

Set/Append headers to request

• Host: GitHub
• URL: https://github.com/keq-request/keq-headers
• Owner: keq-request
• License: mit
• Created: 2021-04-26T06:57:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T16:18:07.000Z (over 1 year ago)
• Last Synced: 2025-10-24T13:58:53.412Z (4 months ago)
• Topics: client, header, headers, http, keq, middleware
• Language: TypeScript
• Homepage: https://keq-request.github.io/guide/libraries/keq-headers
• Size: 36.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          



  



KEQ-HEADERS


[![version](https://img.shields.io/npm/v/keq-headers.svg?style=for-the-badge)](https://www.npmjs.com/package/keq-headers)

[![downloads](https://img.shields.io/npm/dm/keq-headers.svg?style=for-the-badge)](https://www.npmjs.com/package/keq-headers)

[![license](https://img.shields.io/npm/l/keq-headers.svg?style=for-the-badge)](https://www.npmjs.com/package/keq-headers)

[![dependencies](https://img.shields.io/librariesio/release/npm/keq-headers?style=for-the-badge)](https://www.npmjs.com/package/keq-headers)

[![Codecov](https://img.shields.io/codecov/c/gh/keq-request/keq-headers?logo=codecov&token=PLF0DT6869&style=for-the-badge)](https://codecov.io/gh/keq-request/keq-headers)

[Document EN]: https://keq-request.github.io/guide/libraries/keq-headers

[Document CN]: https://keq-request.github.io/zh/guide/libraries/keq-headers

[**Document**][Document EN] | [**中文文档**][Document CN]

Set/Append headers to request.

## Usage

```typescript

import { request } from "keq";

import {

  setHeader,

  setHeaders,

  appendHeader,

  appendHeaders,

  insertHeader,

  insertHeaders,

} from "keq-headers";

request

  .use(setHeader("x-user-name", "Kerry"))

  .use(appendHeader("x-user-name", "Marry"))

  .use(insertHeader("x-user-name", "J"))

  .use(

    setHeaders({

      "x-user-name": "Kerry",

      "x-user-id": "1",

    })

  )

  .use(

    appendHeaders({

      "x-user-name": "Marray",

      "x-user-id": "1",

    })

  )

  .use(

    insertHeaders({

      "x-user-name": "J",

      "x-user-id": 1,

    })

  );

```

| **Middleware** | **Description**                                                            |

| :------------- | :------------------------------------------------------------------------- |

| setHeader      | Set a header.If it already exists, the original value will be overwritten. |

| setHeaders     | Set headers.If it already exists, the original value will be overwritten.  |

| appendHeader   | Append a header.                                                           |

| appendHeaders  | Append headers.                                                            |

| insertHeader   | Set a header, if it isn't existed.                                         |

| insertHeaders  | Set headers, if it isn't existed.                                          |

## Contributing & Development

If there is any doubt, it is very welcome to discuss the issue together.