Skip to content

Produces a thorough markdown explanation of a BitBadgesCollection, structured as a professional report with full paragraphs, proper headings, and…

interpretCollection<T>(collection): string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/interpret.ts:336

Produces a thorough markdown explanation of a BitBadgesCollection, structured as a professional report with full paragraphs, proper headings, and human-readable values.

Privacy: Sensitive fields (seed codes, preimages, private params, template info, signature challenge content, voting challenge content) are never included in the output.

Type Parameters

T

T extends NumberType

Parameters

collection

BitBadgesCollection<T> | iBitBadgesCollection<T>

A BitBadgesCollection instance or plain interface object

Returns

string

A single markdown string with a comprehensive explanation

Edit this page on GitHub