Class FormatContext

Implements

TagsStoreTrait

Index

Constructors

Methods

tags knownValues assignedNameForTag nameForTag tagForValue tagForName nameForValue summarizer registerTag clone

Constructors

constructor

new FormatContext(
tags?: TagsStore,
knownValues?: KnownValuesStore,
): FormatContext
Parameters
- Optionaltags: TagsStore
- OptionalknownValues: KnownValuesStore
Returns FormatContext
- Defined in envelope/src/format/format-context.ts:61

Methods

tags

tags(): TagsStore
Returns TagsStore
- Defined in envelope/src/format/format-context.ts:67

knownValues

knownValues(): KnownValuesStore
Returns KnownValuesStore
- Defined in envelope/src/format/format-context.ts:72

assignedNameForTag

assignedNameForTag(tag: Tag): string | undefined
Get the assigned name for a tag, if any.
Parameters
- tag: Tag
  The tag to look up
Returns string | undefined
The assigned name, or undefined if no name is registered
Implementation of TagsStoreTrait.assignedNameForTag
- Defined in envelope/src/format/format-context.ts:77

nameForTag

nameForTag(tag: Tag): string
Get a display name for a tag.
Parameters
- tag: Tag
  The tag to get a name for
Returns string
The assigned name if available, otherwise the tag value as a string
Implementation of TagsStoreTrait.nameForTag
- Defined in envelope/src/format/format-context.ts:81

tagForValue

tagForValue(value: CborNumber): Tag | undefined
Look up a tag by its numeric value.
Parameters
- value: CborNumber
  The numeric tag value
Returns Tag | undefined
The Tag object if found, undefined otherwise
Implementation of TagsStoreTrait.tagForValue
- Defined in envelope/src/format/format-context.ts:85

tagForName

tagForName(name: string): Tag | undefined
Look up a tag by its name.
Parameters
- name: string
  The tag name
Returns Tag | undefined
The Tag object if found, undefined otherwise
Implementation of TagsStoreTrait.tagForName
- Defined in envelope/src/format/format-context.ts:89

nameForValue

nameForValue(value: CborNumber): string
Get a display name for a tag value.
Parameters
- value: CborNumber
  The numeric tag value
Returns string
The tag name if registered, otherwise the value as a string
Implementation of TagsStoreTrait.nameForValue
- Defined in envelope/src/format/format-context.ts:93

summarizer

summarizer(tag: CborNumber): CborSummarizer | undefined
Get a custom summarizer function for a tag, if registered.
Parameters
- tag: CborNumber
  The numeric tag value
Returns CborSummarizer | undefined
The summarizer function if registered, undefined otherwise
Implementation of TagsStoreTrait.summarizer
- Defined in envelope/src/format/format-context.ts:97

registerTag

registerTag(value: number | bigint, name: string): void
Parameters
- value: number | bigint
- name: string
Returns void
- Defined in envelope/src/format/format-context.ts:102

clone

clone(): FormatContext
Returns FormatContext
- Defined in envelope/src/format/format-context.ts:107