Skip to content

T extends NumberType

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

Extends

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

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

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

Parameters

data

iIPFSTotalsDoc<T>

Returns

IPFSTotalsDoc<T>

Overrides

BaseNumberTypeClass.constructor

Properties

_docId

_docId: string

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

A unique stringified document ID

Implementation of

iIPFSTotalsDoc._docId


_id?

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of

iIPFSTotalsDoc._id


bytesUploaded

bytesUploaded: T

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

The total bytes uploaded

Implementation of

iIPFSTotalsDoc.bytesUploaded

Methods

clone()

clone(): IPFSTotalsDoc

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

Deep copies the object and returns a new instance.

Returns

IPFSTotalsDoc

Inherited from

BaseNumberTypeClass.clone


convert()

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

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

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(item) => U

options?

ConvertOptions

Returns

IPFSTotalsDoc<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/api-indexer/docs-types/docs.ts:1728

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

Edit this page on GitHub