Class Number

A primitive number value

Hierarchy

Number
- CheckedNumber

Implements

IMutable

Index

Constructors

constructor

Accessors

value

Methods

Constructors

constructor

new Number(value: Accepted, _?: IOptions): Number

- Defined in Number.ts:47
Parameters
- value: Accepted
- Default value _: IOptions = {}
Returns Number

Accessors

value

get value(): number
set value(value: number): void

- Defined in Number.ts:58
Returns number
- Defined in Number.ts:62
Parameters
- value: number
Returns void

Methods

__@toPrimitive

__@toPrimitive(hint: "string" | "number" | "default"): string | number

Implementation of IMutable.__@toPrimitive
- Defined in Number.ts:69
Converts the object into a primitive

Parameters
- hint: "string" | "number" | "default"
Returns string | number

__@toStringTag

__@toStringTag(): string

Implementation of IMutable.__@toStringTag
- Defined in Number.ts:79
The string to use for the default toString function

Returns string

get

get(): number

Implementation of IMutable.get
- Defined in Number.ts:122
Returns number

set

set(value: Accepted | Any): INumber

- Defined in Number.ts:117
Parameters
- value: Accepted | Any
Returns INumber

toJSON

toJSON(_?: string): any | number | string | boolean | null

Implementation of IMutable.toJSON
- Defined in Number.ts:98
Converts the primitive into it's JSON representation

Parameters
- Default value _: string = ""
Returns any | number | string | boolean | null

the object to serialize with JSON.stringify

toString

toString(): string

Implementation of IMutable.toString
- Defined in Number.ts:86
Converts the primitive into it's string representation. Often has a unit value associated with it such as 125ms

Returns string

valueOf

valueOf(): number

Implementation of IMutable.valueOf
- Defined in Number.ts:113
Retrieves the actual value of the number

Returns number