Class: ApprovalItemDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:288

Extends#

• BaseNumberTypeClass<ApprovalItemDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iApprovalItemDoc<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:311

Parameters#

data#

iApprovalItemDoc<T>

Returns#

ApprovalItemDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:289

A unique stringified document ID

Implementation of#

iApprovalItemDoc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:290

A unique document ID (Mongo DB ObjectID)

Implementation of#

iApprovalItemDoc._id

---

approval#

approval: CollectionApproval<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:301

Approval itself

Implementation of#

iApprovalItemDoc.approval

---

approvalId#

approvalId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:292

The approval ID

Implementation of#

iApprovalItemDoc.approvalId

---

approvalLevel#

approvalLevel: "incoming" | "outgoing"

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:293

The approval level

Implementation of#

iApprovalItemDoc.approvalLevel

---

approvalType#

approvalType: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:295

The approval type

Implementation of#

iApprovalItemDoc.approvalType

---

approverAddress#

approverAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:294

The approver address

Implementation of#

iApprovalItemDoc.approverAddress

---

collectionId#

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:291

The collection ID

Implementation of#

iApprovalItemDoc.collectionId

---

deletedAt?#

optional deletedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:300

Deleted at timestamp

Implementation of#

iApprovalItemDoc.deletedAt

---

denom?#

optional denom?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:305

Denom

Implementation of#

iApprovalItemDoc.denom

---

intentPayAmount?#

optional intentPayAmount?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:308

Intent: the amount the creator pays out

Implementation of#

iApprovalItemDoc.intentPayAmount

---

intentPayDenom?#

optional intentPayDenom?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:306

Intent: the denom the creator pays out

Implementation of#

iApprovalItemDoc.intentPayDenom

---

intentReceiveAmount?#

optional intentReceiveAmount?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:309

Intent: the amount the creator receives

Implementation of#

iApprovalItemDoc.intentReceiveAmount

---

intentReceiveDenom?#

optional intentReceiveDenom?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:307

Intent: the denom the creator receives

Implementation of#

iApprovalItemDoc.intentReceiveDenom

---

isActive?#

optional isActive?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:302

Is active currently

Implementation of#

iApprovalItemDoc.isActive

---

nextCheckTime?#

optional nextCheckTime?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:303

Next check time

Implementation of#

iApprovalItemDoc.nextCheckTime

---

numTransfersLeft?#

optional numTransfersLeft?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:304

Number of transfers left

Implementation of#

iApprovalItemDoc.numTransfersLeft

---

price?#

optional price?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:296

The price of the listing

Implementation of#

iApprovalItemDoc.price

---

sufficientBalances?#

optional sufficientBalances?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:299

Owner has sufficient balances

Implementation of#

iApprovalItemDoc.sufficientBalances

---

tokenId?#

optional tokenId?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:297

The token ID

Implementation of#

iApprovalItemDoc.tokenId

---

used?#

optional used?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:298

Explicitly marked as used or expired

Implementation of#

iApprovalItemDoc.used

Methods#

clone()#

clone(): ApprovalItemDoc

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

Deep copies the object and returns a new instance.

Returns#

ApprovalItemDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:340

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

ApprovalItemDoc<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/api-indexer/docs-types/docs.ts:336

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