getFormatSync Method
Retrieves a format definition using only schema metadata already loaded in the context.
It follows the same selection order as getFormat but never asks a locater to load a schema. Returns undefined when required metadata is not cached.
Unlike getFormat, which logs lookup errors and returns undefined, this method treats only a schema that is still loading as a cache miss and rethrows other errors.
getFormatSync(name: string, system?: UnitSystemKey): FormatDefinition | undefined
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| system | UnitSystemKey |
Returns - FormatDefinition | undefined
Defined in
Last Updated: 06 October, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.