ReferenceAPI
DecodeResult
The outcome of reading a preset code.
How this is generated
Source: lib/preset.ts. Script: scripts/build-reference.mts. Command:
pnpm run generate.
Everything below is copied from the symbol, so a page is improved by improving its doc comment. The API index says why there is a page per symbol and what these pages still do not carry.
DecodeResult
The outcome of reading a preset code. Either the preset and its version, or an error and a sentence a person can act on.
| Kind | Declared in |
|---|---|
| interface | lib/preset.ts |
export interface DecodeResult {
preset: Preset | null
version: number | null
error: DecodeError | null
message: string | null
}