Class CustomPage<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<CustomPage<T>>
- CustomPage

Implements

iCustomPage<T>

Index

Constructors

Properties

description items title

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

new CustomPage<T>(data): CustomPage<T>
Type Parameters
- T extends NumberType
Parameters
- data: iCustomPage<T>
Returns CustomPage<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:415

Properties

description

description: string

The description of the custom page

items

items: BatchBadgeDetailsArray<T>

The badge IDs to display on the custom page

title

title: string

The title of the custom page

Methods

clone

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

Returns CustomPage<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:100

convert

convert<U>(convertFunction): CustomPage<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
Returns CustomPage<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:422

equals

equals<U>(other, normalizeNumberTypes?): 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:96

getNumberFieldNames

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

Returns string[]
Inherited from BaseNumberTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:106

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:88

toJsonString

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

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