Class GetOwnersForBadgePayload

Hierarchy (View Summary, Expand)

CustomTypeClass<GetOwnersForBadgePayload>
- GetOwnersForBadgePayload

Implements

iGetOwnersForBadgePayload

Index

Constructors

Properties

bookmark? sortBy?

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString FromQuery

Constructors

constructor

new GetOwnersForBadgePayload(
payload: iGetOwnersForBadgePayload,
): GetOwnersForBadgePayload
Parameters
- payload: iGetOwnersForBadgePayload
Returns GetOwnersForBadgePayload
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/requests/collections.ts:123

Properties

`Optional`bookmark

bookmark?: string

The pagination bookmark for where to start the request. Bookmarks are obtained via the previous response. "" for first request.

`Optional`sortBy

sortBy?: "amount"

Sort by amount descending.

Methods

clone

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

Returns GetOwnersForBadgePayload
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:105

convert

convert<U extends NumberType>(
_convertFunction?: (val: NumberType) => U,
options?: ConvertOptions,
): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional_convertFunction: (val: NumberType) => U
- Optionaloptions: ConvertOptions
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:124

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

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

hasNumberFields

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

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in src/common/base.ts:115

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

toJsonString

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

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

`Static`FromQuery

FromQuery(query: ParsedQs): GetOwnersForBadgePayload
Parameters
- query: ParsedQs
Returns GetOwnersForBadgePayload
- Defined in src/api-indexer/requests/collections.ts:129