Class: ClaimCachePolicy<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:66

Extends#

• BaseNumberTypeClass<ClaimCachePolicy<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iClaimCachePolicy<T>

Constructors#

Constructor#

new ClaimCachePolicy<T>(data): ClaimCachePolicy<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:71

Parameters#

data#

iClaimCachePolicy<T>

Returns#

ClaimCachePolicy<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

alwaysPermanent?#

optional alwaysPermanent?: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:68

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

Implementation of#

iClaimCachePolicy.alwaysPermanent

---

permanentAfter?#

optional permanentAfter?: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:69

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

Implementation of#

iClaimCachePolicy.permanentAfter

---

ttl?#

optional ttl?: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:67

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

Implementation of#

iClaimCachePolicy.ttl

Methods#

clone()#

clone(): ClaimCachePolicy

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

ClaimCachePolicy

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): ClaimCachePolicy<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:82

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ClaimCachePolicy<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:78

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString