UNPKG

1.22 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/proxy-addr`
3
4# Summary
5This package contains type definitions for proxy-addr (https://github.com/jshttp/proxy-addr#readme).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/proxy-addr.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/proxy-addr/index.d.ts)
10````ts
11/// <reference types="node" />
12import { IncomingMessage } from "http";
13
14export = proxyAddr;
15
16declare function proxyAddr(
17 req: IncomingMessage,
18 trust: proxyAddr.Address | proxyAddr.Address[] | ((addr: string, i: number) => boolean),
19): string;
20
21declare namespace proxyAddr {
22 function all(req: IncomingMessage, trust?: Address | Address[] | ((addr: string, i: number) => boolean)): string[];
23 function compile(val: Address | Address[]): (addr: string, i: number) => boolean;
24
25 type Address = "loopback" | "linklocal" | "uniquelocal" | string;
26}
27
28````
29
30### Additional Details
31 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
32 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
33
34# Credits
35These definitions were written by [BendingBender](https://github.com/BendingBender).
36
\No newline at end of file