Class Id

This class is used to define mosaicIds and namespaceIds

Hierarchy

UInt64
- Id

Index

Constructors

constructor

Properties

higher
lower

Methods

Constructors

constructor

new Id(uintArray: number[]): Id

Inherited from UInt64.constructor
- Defined in model/UInt64.ts:80
Constructor

Parameters
- uintArray: number[]
Returns Id

Properties

Readonly higher

higher: number

uint64 higher part

Readonly lower

lower: number

uint64 lower part

Methods

add

add(other: UInt64): UInt64

Inherited from UInt64.add
- Defined in model/UInt64.ts:158
UInt64 add operation

Parameters
- other: UInt64
Returns UInt64

compact

compact(): number

Inherited from UInt64.compact
- Defined in model/UInt64.ts:125
Compact higher and lower uint parts into a uint

Returns number

compare

compare(other: UInt64): number

Inherited from UInt64.compare
- Defined in model/UInt64.ts:147
Compares two UInt64

Parameters
- other: UInt64
Returns number
- -1, 0, 1

equals

equals(other: UInt64): boolean

Inherited from UInt64.equals
- Defined in model/UInt64.ts:138
Compares for equality

Parameters
- other: UInt64
Returns boolean

Private pad

pad(str: any, maxVal: any): string

- Defined in model/Id.ts:46
Parameters
- str: any
- maxVal: any
Returns string

subtract

subtract(other: UInt64): UInt64

Inherited from UInt64.subtract
- Defined in model/UInt64.ts:169
UInt64 add operation

Parameters
- other: UInt64
Returns UInt64

toDTO

toDTO(): number[]

Inherited from UInt64.toDTO
- Defined in model/UInt64.ts:99
Get DTO representation with format: [lower, higher]

Returns number[]

toHex

toHex(): string

Overrides UInt64.toHex
- Defined in model/Id.ts:34
Get string value of id

Returns string

toString

toString(): string

Inherited from UInt64.toString
- Defined in model/UInt64.ts:117
Get numeric string representation

Returns string

Static fromHex

fromHex(hexId: string): Id

Overrides UInt64.fromHex
- Defined in model/Id.ts:23
Parameters
- hexId: string
Returns Id

Static fromNumericString

fromNumericString(input: string): UInt64

Inherited from UInt64.fromNumericString
- Defined in model/UInt64.ts:61
Parses a numeric string into a UInt64.

Parameters
- input: string
  
  A numeric string.
Returns UInt64

The uint64 representation of the input.

Static fromUint

fromUint(value: number): UInt64

Inherited from UInt64.fromUint
- Defined in model/UInt64.ts:39
Create from uint value

Parameters
- value: number
Returns UInt64

Static isLongNumericString

isLongNumericString(input: string): boolean

Inherited from UInt64.isLongNumericString
- Defined in model/UInt64.ts:74
Check if input string is a numeric string or not

Parameters
- input: string
  
  A string.
Returns boolean

Generated using TypeDoc