Class CollectionDoc<T>

Constructors

constructor

new CollectionDoc<T>(data): CollectionDoc<T>
Type Parameters
- T extends NumberType
Parameters
- data: iCollectionDoc<T>
Returns CollectionDoc<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:127

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

aliasAddress

aliasAddress: string

The alias BitBadges address for the collection

badgeMetadataTimeline

badgeMetadataTimeline: BadgeMetadataTimeline<T>[]

The badge metadata timeline

balancesType

balancesType:
    | "Standard"
    | "Off-Chain - Indexed"
    | "Non-Public"
    | "Off-Chain - Non-Indexed"

The type of balances (i.e. "Standard", "Off-Chain - Indexed", "Non-Public, "Off-Chain - Non-Indexed")

collectionApprovals

collectionApprovals: CollectionApproval<T>[]

The collection approved transfers timeline

collectionId

collectionId: T

The collection ID

collectionMetadataTimeline

collectionMetadataTimeline: CollectionMetadataTimeline<T>[]

The collection metadata timeline

collectionPermissions

collectionPermissions: CollectionPermissions<T>

The collection permissions

createdBlock

createdBlock: T

The block number when this collection was created

createdBy

createdBy: string

The BitBadges address of the user who created this collection

createdTimestamp

createdTimestamp: T

The timestamp when this collection was created (milliseconds since epoch)

customDataTimeline

customDataTimeline: CustomDataTimeline<T>[]

The custom data timeline

defaultBalances

defaultBalances: UserBalanceStore<T>

The default balances for users who have not interacted with the collection yet. Only used if collection has "Standard" balance type.

isArchivedTimeline

isArchivedTimeline: IsArchivedTimeline<T>[]

The is archived timeline

managerTimeline

managerTimeline: ManagerTimeline<T>[]

The manager timeline

offChainBalancesMetadataTimeline

offChainBalancesMetadataTimeline: OffChainBalancesMetadataTimeline<T>[]

The off-chain balances metadata timeline

standardsTimeline

standardsTimeline: StandardsTimeline<T>[]

The standards timeline

updateHistory

updateHistory: UpdateHistory<T>[]

The update history of this collection

validBadgeIds

validBadgeIds: UintRangeArray<T>

Valid badge IDs for the collection

Methods

clone

clone(): CollectionDoc<T>
Deep copies the object and returns a new instance.

Returns CollectionDoc<T>
Implementation of CustomType.clone
Overrides BaseNumberTypeClass.clone
- Defined in src/api-indexer/docs/docs.ts:237

convert

convert(convertFunction, options?): CollectionDoc
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((val: NumberType) => U)
 - - (val): U
 - Parameters
 val: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns CollectionDoc
Implementation of CustomType.convert
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:233

equals

equals(other, normalizeNumberTypes?): 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
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Implementation of CustomType.equals
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getBadgeMetadataTimelineValue

getBadgeMetadataTimelineValue(time?): BadgeMetadata<bigint>[]
Gets the badge metadata at a specific time (Date.now() by default).

This gets the timeline value. For the actual fetched value, use getBadgeMetadata() instead.
Parameters
- Optionaltime: NumberType
Returns BadgeMetadata<bigint>[]
- Defined in src/api-indexer/docs/docs.ts:190

getCollectionMetadataTimelineValue

getCollectionMetadataTimelineValue(time?): undefined | CollectionMetadata
Gets the collection metadata at a specific time (Date.now() by default).

This gets the timeline value. For the actual fetched value, use getCollectionMetadata() instead.
Parameters
- Optionaltime: NumberType
Returns undefined | CollectionMetadata
- Defined in src/api-indexer/docs/docs.ts:181

getCustomData

getCustomData(time?): undefined | string
Gets the custom data at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | string
- Defined in src/api-indexer/docs/docs.ts:204

getDefaultUserBalance

getDefaultUserBalance(): UserBalanceStore<T>
Creates a blank balance object with the genesis default approvals and balances.

Returns UserBalanceStore<T>
- Defined in src/api-indexer/docs/docs.ts:225

getIsArchived

getIsArchived(time?): undefined | boolean
Gets the is archived at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | boolean
- Defined in src/api-indexer/docs/docs.ts:218

getManager

getManager(time?): undefined | string
Gets the manager at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | string
- Defined in src/api-indexer/docs/docs.ts:172

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Implementation of CustomType.getNumberFieldNames
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/api-indexer/docs/docs.ts:229

getOffChainBalancesMetadata

getOffChainBalancesMetadata(time?): undefined | OffChainBalancesMetadata
Gets the off-chain balances metadata at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | OffChainBalancesMetadata
- Defined in src/api-indexer/docs/docs.ts:197

getStandards

getStandards(time?): undefined | string[]
Gets the standards at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | string[]
- Defined in src/api-indexer/docs/docs.ts:211

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Implementation of CustomType.hasNumberFields
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Implementation of CustomType.toJson
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Implementation of CustomType.toJsonString
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

Class CollectionDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CollectionDoc<T>

Properties

_docId

Optional_id

aliasAddress

badgeMetadataTimeline

balancesType

collectionApprovals

collectionId

collectionMetadataTimeline

collectionPermissions

createdBlock

createdBy

createdTimestamp

customDataTimeline

defaultBalances

isArchivedTimeline

managerTimeline

offChainBalancesMetadataTimeline

standardsTimeline

updateHistory

validBadgeIds

Methods

clone

Returns CollectionDoc<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns CollectionDoc<U>

equals

Type Parameters

Parameters

Returns boolean

getBadgeMetadataTimelineValue

Parameters

Returns BadgeMetadata<bigint>[]

getCollectionMetadataTimelineValue

Parameters

Returns undefined | CollectionMetadata

getCustomData

Parameters

Returns undefined | string

getDefaultUserBalance

Returns UserBalanceStore<T>

getIsArchived

Parameters

Returns undefined | boolean

getManager

Parameters

Returns undefined | string

getNumberFieldNames

Returns string[]

getOffChainBalancesMetadata

Parameters

Returns undefined | OffChainBalancesMetadata

getStandards

Parameters

Returns undefined | string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

Settings

On This Page

`Optional`_id