Class OblUtil

.obl (Open Board Logging) Utility

Provides parsing and generation support for the .obl format.

Index

Constructors

Methods

fromHistoryEntries parse stringify toHistoryEntries

Constructors

constructor

new OblUtil(): OblUtil
Returns OblUtil

Methods

`Static`fromHistoryEntries

fromHistoryEntries(
    entries: HistoryEntry[],
    userId: string,
    source?: string,
): OblFile
Convert HistoryEntries to an OBL file object.
Parameters
- entries: HistoryEntry[]
- userId: string
- Optionalsource: string
Returns OblFile
- Defined in src/utilities/analytics/metrics/obl.ts:117

`Static`parse

parse(json: string): OblFile
Parse an OBL JSON string. Handles the optional /* notice * / at the start of the file.
Parameters
- json: string
Returns OblFile
- Defined in src/utilities/analytics/metrics/obl.ts:23

`Static`stringify

stringify(obl: OblFile, includeNotice?: boolean): string
Stringify an OBL file object. Optionally adds the recommended notice comment.
Parameters
- obl: OblFile
- includeNotice: boolean = true
Returns string
- Defined in src/utilities/analytics/metrics/obl.ts:39

`Static`toHistoryEntries

toHistoryEntries(obl: OblFile): HistoryEntry[]
Convert an OBL file to internal HistoryEntry format.
Parameters
- obl: OblFile
Returns HistoryEntry[]
- Defined in src/utilities/analytics/metrics/obl.ts:50