Project @niobium/coder

Type declaration

• DataCoder: typeof DataCoder

• Serializer: typeof Serializer

• _Buffer: any

• coderTools: object

  • BASE_ALPHABETS: object

    • BASE16: string

    • BASE36: string

    • BASE58: string

    • BASE62: string

    • BASE66: string

  • BaseX: function

    • • (ALPHABET: string): base.BaseConverter

      • Parameters

        • ALPHABET: string

        Returns base.BaseConverter

  • base16Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult

  • base16Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • base32Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult | Uint8Array

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult | Uint8Array

  • base32Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • base36Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult

  • base36Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • base58Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult | Uint8Array

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult | Uint8Array

  • base58Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • base62Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult

  • base62Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • base64Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult | Uint8Array

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult | Uint8Array

  • base64Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • base66Decode: function

    • • (what: string, asBuffer?: boolean, asAscii?: boolean): DecodeResult

      • Parameters

        • what: string

        • asBuffer: boolean = false

        • asAscii: boolean = false

        Returns DecodeResult

  • base66Encode: function

    • • (what: string | Buffer, asAscii?: boolean): string

      • Parameters

        • what: string | Buffer

        • asAscii: boolean = false

        Returns string

  • binFlagsToBuf: function

    • • (arr: boolean[]): Buffer

      • Parameters

        • arr: boolean[]

        Returns Buffer

  • bufToBinFlags: function

    • • (buf: Buffer, offset: number): Boolean[]

      • Parameters

        • buf: Buffer

        • offset: number

        Returns Boolean[]

  • bufToDouble: function

    • • (buf: Buffer, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToFloat: function

    • • (buf: Buffer, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToInt: function

    • • (buf: Buffer, len?: number, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • len: number = 7

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToInt16: function

    • • (buf: Buffer, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToInt16U: function

    • • (buf: Buffer, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToInt32: function

    • • (buf: Buffer, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToInt32U: function

    • • (buf: Buffer, offset?: number, be?: boolean): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        • be: boolean = false

        Returns number

  • bufToInt8: function

    • • (buf: Buffer, offset?: number): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        Returns number

  • bufToInt8U: function

    • • (buf: Buffer, offset?: number): number

      • Parameters

        • buf: Buffer

        • offset: number = 0

        Returns number

  • crc32: any

  • doubleToBuf: function

    • • (int: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • be: boolean = false

        Returns Buffer

  • floatToBuf: function

    • • (int: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • be: boolean = false

        Returns Buffer

  • hexToBinStr: function

    • • (val: string): string

      • Parameters

        • val: string

        Returns string

  • int16ToBuf: function

    • • (int: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • be: boolean = false

        Returns Buffer

  • int16UToBuf: function

    • • (int: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • be: boolean = false

        Returns Buffer

  • int32ToBuf: function

    • • (int: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • be: boolean = false

        Returns Buffer

  • int32UToBuf: function

    • • (int: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • be: boolean = false

        Returns Buffer

  • int53toTwoInt32: function

    • • (val: number): number[]

      • Parameters

        • val: number

        Returns number[]

  • int8ToBuf: function

    • • (int: number): Buffer

      • Parameters

        • int: number

        Returns Buffer

  • int8UToBuf: function

    • • (int: number): Buffer

      • Parameters

        • int: number

        Returns Buffer

  • intToBuf: function

    • • (int: number, len?: number, be?: boolean): Buffer

      • Parameters

        • int: number

        • len: number = 7

        • be: boolean = false

        Returns Buffer

  • pad: function

    • • (str: string, z?: number): string

      • Parameters

        • str: string

        • z: number = 8

        Returns string

  • twoInt32toInt53: function

    • • (val: number[]): number

      • Parameters

        • val: number[]

        Returns number

• dataCoder: DataCoder

• nTools: nTools

• serializer: Serializer