## Index

### Variables

- DIGIT_REGEXP
- isip
- parseip

### Functions

- all
- compile
- compileRangeSubnets
- compileTrust
- parseNetmask
- parseipNotation
- proxyaddr
- trustMulti
- trustNone
- trustSingle

### Object literals

- IP_RANGES

## Variables

### Const DIGIT_REGEXP

DIGIT_REGEXP: RegExp = /^[0-9]+$/

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:34

### Const isip

isip: any = ipaddr.isValid

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:35

### Const parseip

parseip: any = ipaddr.parse

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:36

## Functions

### all

- all(req: OpineRequest, trust: Function | string[] | string): any

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:57

  Get all addresses in the request, optionally stopping at the first untrusted.

  #### Parameters

  - ##### req: OpineRequest

  - ##### trust: Function | string[] | string

  #### Returns any

### Private compile

- compile(value: string[] | string): trust

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:85

  Compile argument into trust function.

  #### Parameters

  - ##### value: string[] | string

  #### Returns trust

### Private compileRangeSubnets

- compileRangeSubnets(arr: string[]): any[]

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:122

  Compile `arr` elements into range subnets.

  #### Parameters

  - ##### arr: string[]

  #### Returns any[]

### Private compileTrust

- compileTrust(rangeSubnets: any[]): trust

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:138

  Compile range subnet array into trust function.

  #### Parameters

  - ##### rangeSubnets: any[]

  #### Returns trust

### Private parseNetmask

- parseNetmask(netmask: string): any

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:199

  Parse netmask string into CIDR range.

  #### Parameters

  - ##### netmask: string

  #### Returns any

### Private parseipNotation

- parseipNotation(note: string): any[]

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:155

  Parse IP notation string into range subnet.

  #### Parameters

  - ##### note: string

  #### Returns any[]

### proxyaddr

- proxyaddr(req: OpineRequest, trust: Function | string[] | string): any

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:213

  Determine address of proxied request.

  #### Parameters

  - ##### req: OpineRequest

  - ##### trust: Function | string[] | string

  #### Returns any

### Private trustMulti

- trustMulti(subnets: any[]): trust

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:246

  Compile trust function for multiple subnets.

  #### Parameters

  - ##### subnets: any[]

  #### Returns trust

### Private trustNone

- trustNone(): boolean

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:236

  Static trust function to trust nothing.

  #### Returns boolean

### Private trustSingle

- trustSingle(subnet: any[]): trust

- - Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:292

  Compile trust function for single subnet.

  #### Parameters

  - ##### subnet: any[]

  #### Returns trust

## Object literals

### Private Const IP_RANGES

IP_RANGES: object

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:43

Pre-defined IP ranges.

### linklocal

linklocal: string[] = ["169.254.0.0/16", "fe80::/10"]

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:44

### loopback

loopback: string[] = ["127.0.0.1/8", "::1/128"]

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:45

### uniquelocal

uniquelocal: string[] = ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "fc00::/7"]

- Defined in home/runner/work/opine/opine/src/utils/proxyAddr.ts:46

Generated using TypeDoc