Class RefreshStatusSuccessResponse<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<RefreshStatusSuccessResponse<T>>
- RefreshStatusSuccessResponse

Implements

iRefreshStatusSuccessResponse<T>

Index

Constructors

Properties

errorDocs inQueue refreshDoc

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new RefreshStatusSuccessResponse<T>(data): RefreshStatusSuccessResponse<T>
Type Parameters
- T extends NumberType
Parameters
- data: iRefreshStatusSuccessResponse<T>
Returns RefreshStatusSuccessResponse<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/api-indexer/requests/collections.ts:375

Properties

errorDocs

errorDocs: QueueDoc<T>[]

Array of error documents corresponding to the collection.

inQueue

inQueue: boolean

Boolean indicating if the collection is currently in the queue.

refreshDoc

refreshDoc: RefreshDoc<T>

The status information corresponding to the collection.

Methods

clone

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

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

convert

convert<U>(convertFunction, options?): RefreshStatusSuccessResponse<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 RefreshStatusSuccessResponse<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/requests/collections.ts:382

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[]
Inherited from BaseNumberTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:127

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