Class RefreshDoc<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<RefreshDoc<T>>
- RefreshDoc

Implements

iRefreshDoc<T>

Index

Constructors

Properties

_docId _id? collectionId refreshRequestTime

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

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

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

collectionId

collectionId: T

The collection ID

refreshRequestTime

refreshRequestTime: T

The time the refresh was requested (Unix timestamp in milliseconds)

Methods

clone

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

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

convert

convert<U>(convertFunction): RefreshDoc<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 RefreshDoc<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:1073

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[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/api-indexer/docs/docs.ts:1069

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