Class: PluginDoc<T>

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

Extends#

• BaseNumberTypeClass<PluginDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iPluginDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iPluginDoc<T>

Returns#

PluginDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iPluginDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iPluginDoc._id

---

createdAt#

createdAt: T

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

Implementation of#

iPluginDoc.createdAt

---

createdBy#

createdBy: string

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

The BitBadges address who created the plugin doc

Implementation of#

iPluginDoc.createdBy

---

deletedAt?#

optional deletedAt?: T

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

Implementation of#

iPluginDoc.deletedAt

---

lastUpdated#

lastUpdated: T

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

Implementation of#

iPluginDoc.lastUpdated

---

locale?#

optional locale?: string

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

Locale that is supported by the plugin. By default, we assume 'en' is supported if not specified.

Implementation of#

iPluginDoc.locale

---

managedBy#

managedBy: string

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

The BitBadges address of the user who is currently managing this

Implementation of#

iPluginDoc.managedBy

---

metadata#

metadata: object

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

createdBy#

createdBy: string

description#

description: string

documentation?#

optional documentation?: string

image#

image: string

name#

name: string

parentApp?#

optional parentApp?: string

sourceCode?#

optional sourceCode?: string

supportLink?#

optional supportLink?: string

Implementation of#

iPluginDoc.metadata

---

pluginId#

pluginId: string

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

The unique plugin ID

Implementation of#

iPluginDoc.pluginId

---

pluginSecret?#

optional pluginSecret?: string

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

The secret of the plugin. Used to verify BitBadges as origin of request.

Implementation of#

iPluginDoc.pluginSecret

---

reviewCompleted#

reviewCompleted: boolean

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

Review process completed

Implementation of#

iPluginDoc.reviewCompleted

---

toPublish#

toPublish: boolean

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

To publish to directory?

Implementation of#

iPluginDoc.toPublish

---

versions#

versions: PluginVersionConfig<T>[]

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

Array of version-controlled plugin configurations

Implementation of#

iPluginDoc.versions

Methods#

clone()#

clone(): PluginDoc<T>

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

Deep copies the object and returns a new instance.

Returns#

PluginDoc<T>

Overrides#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PluginDoc<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

---

getLatestVersion()#

getLatestVersion(): PluginVersionConfig<T>

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

Returns#

PluginVersionConfig<T>

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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