docs_data.ts

What the docs pages render from the results file: the rosters and the inputs, so a table in a tome is the data and can't fall behind it.

view source

Declarations
#

3 declarations

docs_data_context
#

docs_data.ts view source

{ get: (error_message?: string | undefined) => () => DocsData; get_maybe: () => (() => DocsData) | undefined; set: (value: () => DocsData) => () => DocsData; } import {docs_data_context} from '@ryanatkn/syntax-highlighter-bench/docs_data.js';

The docs data, set by the docs layout from its load and read by the tomes.

DocsData
#

docs_data.ts view source

DocsData import type {DocsData} from '@ryanatkn/syntax-highlighter-bench/docs_data.js';

The parts of the rendered results file that the docs pages show.

source

type SiteResultsSource

langs

type BenchLang[]

sets

type BenchSet[]

inputs

type BenchInput[]

corpus_hash

type string

corpus_current

Whether the inputs are the repository's corpus as it is committed.

type boolean

machine

The name of the machine the timed numbers came from, or null when nothing was timed.

type string | null

noise_floor

type BenchNoiseFloor | null

to_docs_data
#

docs_data.ts view source

({ source, results, corpus_current }: SiteResults): DocsData import {to_docs_data} from '@ryanatkn/syntax-highlighter-bench/docs_data.js';

Picks what the docs pages show from the results the site renders.

__0

returns

DocsData

Depends on
#