@types/on-headers
Version:
TypeScript definitions for on-headers
40 lines (31 loc) • 1.48 kB
Markdown
# Installation
> `npm install --save @types/on-headers`
# Summary
This package contains type definitions for on-headers (https://github.com/jshttp/on-headers).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/on-headers.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/on-headers/index.d.ts)
````ts
/// <reference types="node" />
import { ServerResponse } from "http";
/**
* This will add the listener to fire when headers are emitted for res.
* The listener is passed the response object as its context (this).
* Headers are considered emitted only once, right before they
* are sent to the client.
*
* When this is called multiple times on the same res, the listeners
* are fired in the reverse order they were added.
*
* @param res HTTP server response object
* @param listener Function to call prior to headers being emitted,
* the response object is passed as this context.
*/
declare function onHeaders(res: ServerResponse, listener: (this: ServerResponse) => void): void;
export = onHeaders;
````
### Additional Details
* Last updated: Sat, 07 Jun 2025 02:15:25 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node)
# Credits
These definitions were written by [John Jeffery](https://github.com/jjeffery), [BendingBender](https://github.com/BendingBender), and [Sebastian Beltran](https://github.com/bjohansebas).