@webpod/ip - v0.5.2
    Preparing search index...

    Variable ipConst

    ip: {
        Address: any;
        address: (kind?: string, family?: FamilyAlias) => undefined | string;
        addresses: (kind?: string, family?: FamilyAlias) => string[];
        cidr: (cidrString: string) => string;
        isEqual: (addrA: Raw, addrB: Raw) => boolean;
        isPrivate: (addr: Raw) => boolean;
        isPublic: (addr: Raw) => boolean;
        mask: (addr: Raw, mask: Raw) => string;
        normalizeToLong: (addr: string, strict?: boolean) => number;
        not: (addr: Raw) => string;
        or: (addrA: Raw, addrB: Raw) => string;
        cidrSubnet(cidrString: string): LegacySubnet;
        fromLong(n: number | bigint | `${bigint}`): string;
        fromPrefixLen(prefixlen: number, family?: FamilyAlias): string;
        isLoopback(addr: Raw): boolean;
        loopback(family?: FamilyAlias): string;
        subnet(addr: Raw, smask: Raw): LegacySubnet;
        toBuffer(addr: Raw, buff?: BufferLike, offset?: number): BufferLike;
        toLong(addr: Raw): number;
        toString(
            buf: number | BufferLike,
            offset?: number,
            length?: number,
        ): string;
    } = ...

    Type Declaration

    • address: (kind?: string, family?: FamilyAlias) => undefined | string
    • addresses: (kind?: string, family?: FamilyAlias) => string[]
    • cidr: (cidrString: string) => string
    • isEqual: (addrA: Raw, addrB: Raw) => boolean
    • isPrivate: (addr: Raw) => boolean
    • isPublic: (addr: Raw) => boolean
    • mask: (addr: Raw, mask: Raw) => string
    • normalizeToLong: (addr: string, strict?: boolean) => number
    • not: (addr: Raw) => string
    • or: (addrA: Raw, addrB: Raw) => string
    • cidrSubnet: function
      • Parameters

        • cidrString: string

        Returns LegacySubnet

    • fromLong: function
      • Parameters

        • n: number | bigint | `${bigint}`

        Returns string

    • fromPrefixLen: function
      • Parameters

        • prefixlen: number
        • Optionalfamily: FamilyAlias

        Returns string

    • isLoopback: function
      • Parameters

        • addr: Raw

        Returns boolean

    • loopback: function
      • Parameters

        • family: FamilyAlias = 4

        Returns string

    • subnet: function
      • Parameters

        • addr: Raw
        • smask: Raw

        Returns LegacySubnet

    • toBuffer: function
    • toLong: function
      • Parameters

        • addr: Raw

        Returns number

    • toString: function
      • Parameters

        • buf: number | BufferLike
        • offset: number = 0
        • Optionallength: number

        Returns string