Class PluginDoc<T>

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties

_docId _id? approvedUsers createdAt createdBy deletedAt? inviteCode? lastUpdated locale? managedBy metadata pluginId pluginSecret? reviewCompleted toPublish versions

Methods

clone convert equals getLatestVersion getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

approvedUsers

approvedUsers: string[]

createdAt

createdAt: T

createdBy

createdBy: string

The BitBadges address who created the plugin doc

OptionaldeletedAt

deletedAt?: T

OptionalinviteCode

inviteCode?: string

Invite code for the plugin

lastUpdated

lastUpdated: T

Optionallocale

locale?: string

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

managedBy

managedBy: string

The BitBadges address of the user who is currently managing this

metadata

metadata: {
    createdBy: string;
    description: string;
    documentation?: string;
    image: string;
    name: string;
    parentApp?: string;
    sourceCode?: string;
    supportLink?: string;
}

pluginId

pluginId: string

The unique plugin ID

OptionalpluginSecret

pluginSecret?: string

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

reviewCompleted

reviewCompleted: boolean

Review process completed

toPublish

toPublish: boolean

To publish to directory?

versions

versions: PluginVersionConfig<T>[]

Array of version-controlled plugin configurations

Methods

clone

convert

equals

  • equals<U extends CustomType<U>>(
        other: undefined | null | CustomType<U>,
        normalizeNumberTypes?: boolean,
    ): boolean

    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

    Parameters

    • other: undefined | null | CustomType<U>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean

getLatestVersion

getNumberFieldNames

hasNumberFields

toJson

toJsonString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR