Class ClaimCachePolicy<T>

Type Parameters

T extends NumberType

Hierarchy (View Summary, Expand)

BaseNumberTypeClass<ClaimCachePolicy<T>>
- ClaimCachePolicy

Implements

iClaimCachePolicy<T>

Index

Constructors

Properties

alwaysPermanent? permanentAfter? ttl?

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new ClaimCachePolicy<T extends NumberType>(
data: iClaimCachePolicy<T>,
): ClaimCachePolicy<T>
Type Parameters
- T extends NumberType
Parameters
- data: iClaimCachePolicy<T>
Returns ClaimCachePolicy<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/approvals.ts:63

Properties

`Optional`alwaysPermanent

alwaysPermanent?: boolean

Permanent once the claim is calculated once. We will cache results indefinitely.

`Optional`permanentAfter

permanentAfter?: T

Permanent after a specific timestamp. Until then, we use the ttl. We will cache results indefinitely after this timestamp.

`Optional`ttl

ttl?: T

The number of seconds to cache the result. Default is 5 minutes (300 seconds) if none is specified.

Note: This may be overridden by other options

Methods

clone

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

Returns ClaimCachePolicy
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:151

convert

convert<U extends NumberType>(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): ClaimCachePolicy<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns ClaimCachePolicy<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/core/approvals.ts:74

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

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/core/approvals.ts:70

hasNumberFields

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

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

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

toJsonString

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

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