Class IPMask

Hierarchy

IPMask

Index

Constructors

Properties

Accessors

Methods

size toString cidr v4

Constructors

constructor

new IPMask(mask: Uint8Array): IPMask
Parameters
- mask: Uint8Array
Returns IPMask
- Defined in src/net/ip.ts:324

Properties

`Readonly` mask

mask: Uint8Array

Accessors

length

get length(): number
Returns number
- Defined in src/net/ip.ts:325

Methods

size

size(): [number, number]
returns the number of leading ones and total bits in the mask.

Remarks
If the mask is not in the canonical form--ones followed by zeros--then returns [0,0]

Returns
[ones:number, bits:number]

Returns [number, number]
- Defined in src/net/ip.ts:337

toString

toString(): string
Returns string
- Defined in src/net/ip.ts:328

`Static` cidr

cidr(ones: number, bits: number): undefined | IPMask
returns an IPMask consisting of 'ones' 1 bits followed by 0s up to a total length of 'bits' bits.
Parameters
- ones: number
- bits: number
Returns undefined | IPMask
- Defined in src/net/ip.ts:293

`Static` v4

v4(a: number, b: number, c: number, d: number): IPMask
returns the IP mask (in 4-byte form) of the IPv4 mask a.b.c.d.
Parameters
- a: number
- b: number
- c: number
- d: number
Returns IPMask
- Defined in src/net/ip.ts:265

Generated using TypeDoc