Class: ComplianceDoc<T>

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

Extends#

• BaseNumberTypeClass<ComplianceDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iComplianceDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iComplianceDoc<T>

Returns#

ComplianceDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iComplianceDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iComplianceDoc._id

---

accounts#

accounts: object

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

nsfw#

nsfw: object[]

reported#

reported: object[]

Implementation of#

iComplianceDoc.accounts

---

applications#

applications: object

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

nsfw#

nsfw: object[]

reported#

reported: object[]

Implementation of#

iComplianceDoc.applications

---

claims?#

optional claims?: object

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

nsfw#

nsfw: object[]

reported#

reported: object[]

Implementation of#

iComplianceDoc.claims

---

maps?#

optional maps?: object

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

nsfw#

nsfw: object[]

reported#

reported: object[]

Implementation of#

iComplianceDoc.maps

---

tokens#

tokens: object

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

nsfw#

nsfw: BatchTokenDetailsArray<T>

reported#

reported: BatchTokenDetailsArray<T>

Implementation of#

iComplianceDoc.tokens

Methods#

clone()#

clone(): ComplianceDoc

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

Deep copies the object and returns a new instance.

Returns#

ComplianceDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ComplianceDoc<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/common/base.ts:157

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

Returns#

string[]

Inherited from#

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