Class CustomListPage

CustomListPage is a custom list page that can be added to a profile. The items are valid list IDs.

Hierarchy (view full)

CustomTypeClass<CustomListPage>
- CustomListPage

Implements

iCustomListPage

Index

Constructors

Properties

description items title

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

new CustomListPage(data): CustomListPage
Parameters
- data: iCustomListPage
Returns CustomListPage
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:436

Properties

description

description: string

The description of the custom list page

items

items: string[]

The list IDs to display on the custom list page

title

title: string

The title of the custom list page

Methods

clone

clone(): CustomListPage
Deep copies the object and returns a new instance.

Returns CustomListPage
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:58

convert

convert<U>(_convertFunction?): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional_convertFunction: ((val: NumberType) => U)
  - - (val): U
    - Parameters
      val: NumberType
      Returns U
Returns CustomType<any>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Inherited from CustomTypeClass.convert
- Defined in src/common/base.ts:73

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 CustomTypeClass.equals
- Defined in src/common/base.ts:54

getNumberFieldNames

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

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

toJson

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

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in src/common/base.ts:46

toJsonString

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

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in src/common/base.ts:50