Function info

info(options?: InfoOptions): string
Query information about supported bit types.

format defaults to "text", the human-readable rendering. That renderer is only in the variants built with info-text — on bitmark-json it is compiled out and this throws UnsupportedFeatureError; ask for format: "json" there (the JSON views are the contractual ones and are in every variant).
Parameters
- options: InfoOptions = {}
  Info options (e.g. { infoType: "bit", format: "json", bit: "cloze" }).
Returns string
Information string.

Throws
UnsupportedFeatureError if format is "text" on a variant built without the text renderer.
- Defined in packages/bitmark-parser/src/core/api.ts:481