Class String

A primitive string value

Hierarchy

String
- CheckedString

Implements

IMutable

Index

Constructors

constructor

Accessors

value

Methods

Constructors

constructor

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

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

Accessors

value

get value(): string
set value(value: string): void

- Defined in String.ts:42
Returns string
- Defined in String.ts:46
Parameters
- value: string
Returns void

Methods

__@iterator

__@iterator(): IterableIterator<string>

Implementation of IMutable.__@iterator
- Defined in String.ts:70
Iterates of the characters in the string

Returns IterableIterator<string>

__@toPrimitive

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

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

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

__@toStringTag

__@toStringTag(): string

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

Returns string

get

get(): string

Implementation of IMutable.get
- Defined in String.ts:105
Returns string

set

set(value: Accepted | Any): IString

- Defined in String.ts:100
Parameters
- value: Accepted | Any
Returns IString

toJSON

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

Implementation of IMutable.toJSON
- Defined in String.ts:89
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 String.ts:77
Converts the primitive into it's string representation. Often has a unit value associated with it such as 125ms

Returns string

valueOf

valueOf(): string

Implementation of IMutable.valueOf
- Defined in String.ts:96
Retrieves the actual value of the number

Returns string