Class ProvenanceMarkInfo

Wrapper for a provenance mark with additional display information.

Index

Methods

new mark ur bytewords bytemoji comment markdownSummary toJSON fromJSON

Methods

`Static`new

new(mark: ProvenanceMark, comment?: string): ProvenanceMarkInfo
Create a new ProvenanceMarkInfo from a mark.
Parameters
- mark: ProvenanceMark
- comment: string = ""
Returns ProvenanceMarkInfo
- Defined in provenance-mark/src/mark-info.ts:36

mark

mark(): ProvenanceMark
Returns ProvenanceMark
- Defined in provenance-mark/src/mark-info.ts:48

ur

ur(): UR
Returns UR
- Defined in provenance-mark/src/mark-info.ts:52

bytewords

bytewords(): string
Returns string
- Defined in provenance-mark/src/mark-info.ts:56

bytemoji

bytemoji(): string
Returns string
- Defined in provenance-mark/src/mark-info.ts:60

comment

comment(): string
Returns string
- Defined in provenance-mark/src/mark-info.ts:64

markdownSummary

markdownSummary(): string
Generate a markdown summary of the mark.

Returns string
- Defined in provenance-mark/src/mark-info.ts:71

toJSON

toJSON(): Record<string, unknown>
JSON serialization.

Returns Record<string, unknown>
- Defined in provenance-mark/src/mark-info.ts:100

`Static`fromJSON

fromJSON(json: Record<string, unknown>): ProvenanceMarkInfo
Create from JSON object.
Parameters
- json: Record<string, unknown>
Returns ProvenanceMarkInfo
- Defined in provenance-mark/src/mark-info.ts:116