Class: ApiKeyDoc

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

Extends#

• CustomTypeClass<ApiKeyDoc>

Implements#

• iApiKeyDoc

Constructors#

Constructor#

new ApiKeyDoc(data): ApiKeyDoc

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

Parameters#

data#

iApiKeyDoc

Returns#

ApiKeyDoc

Overrides#

CustomTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iApiKeyDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iApiKeyDoc._id

---

apiKey#

apiKey: string

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

Implementation of#

iApiKeyDoc.apiKey

---

bitbadgesAddress#

bitbadgesAddress: string

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

Implementation of#

iApiKeyDoc.bitbadgesAddress

---

createdAt#

createdAt: number

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

Implementation of#

iApiKeyDoc.createdAt

---

intendedUse#

intendedUse: string

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

Implementation of#

iApiKeyDoc.intendedUse

---

label#

label: string

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

Implementation of#

iApiKeyDoc.label

---

lastRequest#

lastRequest: number

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

Implementation of#

iApiKeyDoc.lastRequest

---

numRequests#

numRequests: number

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

Implementation of#

iApiKeyDoc.numRequests

Methods#

clone()#

clone(): ApiKeyDoc

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

Deep copies the object and returns a new instance.

Returns#

ApiKeyDoc

Inherited from#

CustomTypeClass.clone

---

convert()#

convert<U>(_convertFunction?, options?): CustomType<any>

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

Type Parameters#

U#

U extends NumberType

Parameters#

_convertFunction?#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Inherited from#

CustomTypeClass.convert

---

equals()#

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

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

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#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

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

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString