Class: AutoDeletionOptions<T>

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

Extends#

• BaseNumberTypeClass<AutoDeletionOptions<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iAutoDeletionOptions

Constructors#

Constructor#

new AutoDeletionOptions<T>(msg): AutoDeletionOptions<T>

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

Parameters#

msg#

iAutoDeletionOptions

Returns#

AutoDeletionOptions<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

afterOneUse#

afterOneUse: boolean

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

Whether the approval should be deleted after one use.

Implementation of#

iAutoDeletionOptions.afterOneUse

---

afterOverallMaxNumTransfers#

afterOverallMaxNumTransfers: boolean

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

Whether the approval should be deleted after the overall max number of transfers threshold is met.

Implementation of#

iAutoDeletionOptions.afterOverallMaxNumTransfers

---

allowCounterpartyPurge#

allowCounterpartyPurge: boolean

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

Allow counterparty to purge this approval if they are the only initiator

Implementation of#

iAutoDeletionOptions.allowCounterpartyPurge

---

allowPurgeIfExpired#

allowPurgeIfExpired: boolean

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

Allow others to call PurgeApprovals on behalf of this approval owner

Implementation of#

iAutoDeletionOptions.allowPurgeIfExpired

Methods#

clone()#

clone(): AutoDeletionOptions

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

Deep copies the object and returns a new instance.

Returns#

AutoDeletionOptions

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

AutoDeletionOptions<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:1007

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

---

toProto()#

toProto(): AutoDeletionOptions

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

Returns#

AutoDeletionOptions

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): AutoDeletionOptions<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

AutoDeletionOptions<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): AutoDeletionOptions<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

AutoDeletionOptions<U>

---

fromProto()#

static fromProto<U>(item, convertFunction): AutoDeletionOptions<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

AutoDeletionOptions

convertFunction#

(item) => U

Returns#

AutoDeletionOptions<U>