Class ProvenanceMarkInfo

A mark with its UR and identifiers rendered once, plus a comment, for display. Frozen.

Index

Accessors

mark ur bytewords bytemoji comment

Methods

from markdownSummary toJSON fromJSON

Accessors

mark

get mark(): ProvenanceMark
The mark.

Returns ProvenanceMark
- Defined in mark-info.ts:54

ur

get ur(): UR
The mark's UR.

Returns UR
- Defined in mark-info.ts:59

bytewords

get bytewords(): string
The 🅟-prefixed bytewords identifier.

Returns string
- Defined in mark-info.ts:64

bytemoji

get bytemoji(): string
The 🅟-prefixed bytemoji identifier.

Returns string
- Defined in mark-info.ts:69

comment

get comment(): string
The comment, possibly empty.

Returns string
- Defined in mark-info.ts:74

Methods

`Static`from

from(mark: ProvenanceMark, comment?: string): ProvenanceMarkInfo
The mark's UR and its 🅟-prefixed four-word identifiers, with free text to show alongside (empty unless given).
Parameters
- mark: ProvenanceMark
- comment: string = ""
Returns ProvenanceMarkInfo
- Defined in mark-info.ts:41

markdownSummary

markdownSummary(): string
A Markdown block: rule, date, the UR and bytewords as headings, the bytemoji, the comment.

Returns string
- Defined in mark-info.ts:79

toJSON

toJSON(): Record<string, unknown>
ur, bytewords, bytemoji[, comment], mark, as the reference serialises.

Returns Record<string, unknown>
- Defined in mark-info.ts:89

`Static`fromJSON

fromJSON(json: unknown): ProvenanceMarkInfo
The JSON shape, read strictly: ur, bytewords and bytemoji required strings, comment optional, the mark taken from the UR. Any fault is Json.
Parameters
- json: unknown
Returns ProvenanceMarkInfo
- Defined in mark-info.ts:105