Class GroupPage<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<GroupPage<T>>
- GroupPage

Implements

iGroupPage<T>

Index

Constructors

Properties

claimIds? collectionIds? events? listIds? mapIds? metadata pageId points? quests? tiers?

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

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

Properties

`Optional`claimIds

claimIds?: string[]

The claim IDs in the group

`Optional`collectionIds

collectionIds?: T[]

The collection IDs in the group

`Optional`events

events?: Event<T>[]

The events in the group

`Optional`listIds

listIds?: string[]

The address list IDs in the group

`Optional`mapIds

mapIds?: string[]

Mapping IDs in the group

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(): GroupPage<T>
Deep copies the object and returns a new instance.

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

convert

convert<U>(convertFunction, options?): GroupPage<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
- Optionaloptions: ConvertOptions
Returns GroupPage<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:954

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

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

hasNumberFields

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

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

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

toJsonString

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

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