Highlighting API

This reference lists every language, theme, shared highlighter, and stream export from @pierre/diffs.

Shiki passthrough APIs
Language APIs
Theme APIs
Shared highlighter APIs
Render APIs
Stream APIs

Shiki passthrough APIs

Export	Kind	Purpose
`codeToHtml`	Function	Re-exports Shiki's complete code-to-HTML helper.
`createCSSVariablesTheme`	Function	Re-exports Shiki's CSS variable theme factory.

Language APIs

Export	Kind	Purpose
`registerCustomLanguage`	Function	Registers a lazy language and optional file mappings.
`resolveLanguage`	Function	Loads and caches one language registration.
`resolveLanguages`	Function	Loads and caches several language registrations.
`getResolvedOrResolveLanguage`	Function	Returns one cached language or starts its load.
`getResolvedLanguages`	Function	Gets cached registrations for the supplied languages.
`hasResolvedLanguages`	Function	Tests whether language registrations are cached.
`attachResolvedLanguages`	Function	Adds resolved registrations to a highlighter.
`areLanguagesAttached`	Function	Tests whether a highlighter has the supplied languages.
`cleanUpResolvedLanguages`	Function	Clears language resolution state.
`RegisteredCustomLanguages`	Map	Stores registered custom language loaders.
`ResolvedLanguages`	Map	Stores resolved language registrations.
`ResolvingLanguages`	Map	Stores active language load promises.
`AttachedLanguages`	Set	Stores language names attached to the shared highlighter.

Theme APIs

Export	Kind	Purpose
`registerCustomTheme`	Function	Registers a lazy Shiki theme loader.
`CustomThemeLoader`	Type	Defines a raw or resolved Shiki theme loader.
`registerCustomCSSVariableTheme`	Function	Registers a theme that reads CSS variables.
`resolveTheme`	Function	Loads and caches one theme.
`resolveThemes`	Function	Loads and caches several themes.
`getResolvedOrResolveTheme`	Function	Returns one cached theme or starts its load.
`getResolvedThemes`	Function	Gets cached themes by name.
`hasResolvedThemes`	Function	Tests whether themes are cached.
`attachResolvedThemes`	Function	Adds resolved themes to a highlighter.
`areThemesAttached`	Function	Tests whether a highlighter has the supplied themes.
`cleanUpResolvedThemes`	Function	Clears theme resolution state.
`AttachedThemes`	Set	Stores theme names attached to the shared highlighter.

Shared highlighter APIs

Export	Purpose
`getSharedHighlighter`	Gets or creates the shared highlighter for themes and languages.
`preloadHighlighter`	Loads the shared highlighter before a render.
`getHighlighterIfLoaded`	Gets the shared highlighter after load.
`isHighlighterLoaded`	Tests a highlighter cache value for a loaded instance.
`isHighlighterLoading`	Tests a highlighter cache value for an active promise.
`isHighlighterNull`	Tests a highlighter cache value for an empty state.
`disposeHighlighter`	Disposes and clears the shared highlighter.
`getHighlighterOptions`	Converts one language and component options to highlighter input.
`getHighlighterThemeStyles`	Creates theme CSS from a loaded highlighter.
`getThemes`	Converts one theme or light/dark pair to a name list.
`isWorkerContext`	Tests whether code runs in a worker global scope.

Render APIs

Export	Purpose
`renderFileWithHighlighter`	Creates a highlighted file syntax tree.
`renderDiffWithHighlighter`	Creates highlighted deletion and addition syntax trees.
`createTransformerWithState`	Creates Shiki transformers with shared render state.

Stream APIs

Export	Kind	Purpose
`FileStream`	Class	Renders a readable code stream as highlighted rows.
`FileStreamOptions`	Type	Configures stream language, theme, start line, and callbacks.
`CodeToTokenTransformStream`	Class	Converts code chunks to themed or recall tokens.
`CodeToTokenTransformStreamOptions`	Type	Configures stream tokenization and recall tokens.
`ShikiStreamTokenizer`	Class	Tracks stable and unstable tokens across code chunks.
`ShikiStreamTokenizerOptions`	Type	Supplies Shiki token options and a highlighter.
`ShikiStreamTokenizerEnqueueResult`	Type	Returns recalled, stable, and unstable tokens for one chunk.
`RecallToken`	Type	Requests removal of prior unstable tokens.

`FileStream` members

Member	Purpose
`new FileStream(options?)`	Creates a stream renderer.
`setup(source, wrapper)`	Connects a readable code stream to a host.
`setThemeType(themeType)`	Selects system, light, or dark theme mode.
`cleanUp()`	Aborts the stream and releases resources.

`ShikiStreamTokenizer` members

Member	Purpose
`new ShikiStreamTokenizer(options)`	Creates a stateful tokenizer.
`enqueue(chunk)`	Tokenizes one code chunk.
`close()`	Finalizes and returns stable tokens.
`clear()`	Clears accumulated token state.
`clone()`	Copies current tokenizer state.

CodeToTokenTransformStream exposes its tokenizer and options values.

Referenced from SKILL.md

SKILL.mdView in source ↗

27| Root components, parsing, and file extension APIs            | [Core API](references/api-core.md)                     |28| Languages, themes, highlighter state, and streams            | [Highlighting API](references/api-highlighting.md)     |29| Renderers, managers, DOM helpers, comparisons, and constants | [Low-level rendering API](references/api-rendering.md) |