Class ApplicationPage<T>

Type Parameters

T extends NumberType

Hierarchy (View Summary, Expand)

BaseNumberTypeClass<ApplicationPage<T>>
- ApplicationPage

Implements

iApplicationPage<T>

Index

Constructors

Properties

metadata pageId points? quests? tiers?

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new ApplicationPage<T extends NumberType>(
data: iApplicationPage<T>,
): ApplicationPage<T>
Type Parameters
- T extends NumberType
Parameters
- data: iApplicationPage<T>
Returns ApplicationPage<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:965

Properties

metadata

metadata: Metadata<T>

Metadata for the page

pageId

pageId: string

The page ID

`Optional`points

points?: TierWithOptionalWeight<T>[]

Points to display in the page

`Optional`quests

quests?: TierWithOptionalWeight<T>[]

Quests to display in the page

`Optional`tiers

tiers?: TierWithOptionalWeight<T>[]

Tiers to display in the page

Methods

clone

clone(): ApplicationPage<T>
Deep copies the object and returns a new instance.

Returns ApplicationPage<T>
Overrides BaseNumberTypeClass.clone
- Defined in src/api-indexer/docs/docs.ts:982

convert

convert<U extends NumberType>(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): ApplicationPage<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns ApplicationPage<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:978

equals

equals<U extends CustomType<U>>(
other: undefined | null | CustomType<U>,
normalizeNumberTypes?: boolean,
): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:147

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/api-indexer/docs/docs.ts:974

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:161

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:139

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:143