# setheaders

> boilerplate for res.setHeader, protection from being overridden

Latest version **0.4.0** (published 2017-12-31) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install setheaders
pnpm add setheaders
yarn add setheaders
bun add setheaders
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2017-12-31 |
| First published | 2014-11-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hex7c0 |
| Maintainers | hex7c0 |
| Keywords | setHeader, header |

## Links

- npm: https://www.npmjs.com/package/setheaders
- Repository: https://github.com/hex7c0/setheaders
- Issues: https://github.com/hex7c0/setheaders/issues
- npm.io page: https://npm.io/package/setheaders

## Recent versions

- 0.4.0 (latest) — 2017-12-31
- 0.3.0 — 2017-05-14
- 0.2.0 — 2016-12-16
- 0.1.7 — 2016-09-12
- 0.1.6 — 2016-08-30
- 0.1.5 — 2015-11-05
- 0.1.4 — 2015-09-06
- 0.1.3 — 2015-08-03
- 0.1.2 — 2015-08-03
- 0.1.1 — 2015-02-25
- 0.1.0 — 2015-02-23
- 0.0.5 — 2015-02-04
- 0.0.4 — 2015-02-04
- 0.0.3 — 2015-01-10
- 0.0.2 — 2014-11-14
- … 1 more at https://npm.io/package/setheaders/versions

## README

# [setheaders](https://github.com/hex7c0/setheaders)

[![NPM version](https://img.shields.io/npm/v/setheaders.svg)](https://www.npmjs.com/package/setheaders)
[![Linux Status](https://img.shields.io/travis/hex7c0/setheaders.svg?label=linux-osx)](https://travis-ci.org/hex7c0/setheaders)
[![Windows Status](https://img.shields.io/appveyor/ci/hex7c0/setheaders.svg?label=windows)](https://ci.appveyor.com/project/hex7c0/setheaders)
[![Dependency Status](https://img.shields.io/david/hex7c0/setheaders.svg)](https://david-dm.org/hex7c0/setheaders)
[![Coveralls](https://img.shields.io/coveralls/hex7c0/setheaders.svg)](https://coveralls.io/r/hex7c0/setheaders)

boilerplate for res.setHeader, protection from being overridden and more!

## Installation

Install through NPM

```bash
npm install setheaders
```
or
```bash
git clone git://github.com/hex7c0/setheaders.git
```

## API

inside nodejs project, set `pippo` as "X-Foo" header
```js
var setHeader = require('setheaders');

setHeader(res, 'X-Foo', 'pippo');
```

there are different shortcuts, instead of setting correct argument
```js
var setHeader = require('setheaders');

var setProctedHeader  = setHeader.setProctedHeader;  // protected = true
var setOverrideHeader = setHeader.setOverrideHeader; // override  = true
var setWritableHeader = setHeader.setWritableHeader; // writable  = true
```

### setheaders(res, name, value [, protected [, override [, writable] ] ])

#### options

 - `res` - **Object** response to client *(default "required")*
 - `name`- **String** header's name *(default "required")*
 - `value` - **String** header's value *(default "required")*
 - `[protected]` - **true** set protected header, from being overridden before they are written to response *(default "false")*
 - `[override]` - **true** check if I'm trying to override a header *(default "false")*
 - `[writable]` - **true** check if socket is writable, prevent write Error *(default "false")*

## Examples

Take a look at my [examples](examples)

### [License Apache2](LICENSE)

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