Class: SearchPluginsSuccessResponse<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2699

Extends#

• GetPluginsSuccessResponse<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iSearchPluginsSuccessResponse<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2700

Parameters#

data#

iSearchPluginsSuccessResponse<T>

Returns#

SearchPluginsSuccessResponse<T>

Overrides#

GetPluginsSuccessResponse.constructor

Properties#

bookmark?#

optional bookmark?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2678

Bookmark for pagination of the plugins. Only applicable if fetching the directory.

Implementation of#

iSearchPluginsSuccessResponse.bookmark

Inherited from#

GetPluginsSuccessResponse.bookmark

---

plugins#

plugins: PluginDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2677

Implementation of#

iSearchPluginsSuccessResponse.plugins

Inherited from#

GetPluginsSuccessResponse.plugins

Methods#

clone()#

clone(): GetPluginsSuccessResponse

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

Deep copies the object and returns a new instance.

Returns#

GetPluginsSuccessResponse

Inherited from#

GetPluginsSuccessResponse.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2686

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

GetPluginsSuccessResponse<U>

Inherited from#

GetPluginsSuccessResponse.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#

GetPluginsSuccessResponse.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#

GetPluginsSuccessResponse.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#

GetPluginsSuccessResponse.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#

GetPluginsSuccessResponse.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#

GetPluginsSuccessResponse.toJsonString