getFormat Method
Retrieves a format definition from the schema context.
For a KindOfQuantity with a unit system, matching presentation formats are checked first, followed by the persistence unit and then the default presentation format. Without a unit system, the default presentation format is used.
getFormat(name: string, system?: UnitSystemKey): Promise<FormatDefinition | undefined>
| Parameter | Type | Description |
|---|---|---|
| name | string | The full name of the Format or KindOfQuantity. |
| system | UnitSystemKey | Optional unit system used to select a KindOfQuantity format. |
Returns - Promise<FormatDefinition | undefined>
Defined in
Last Updated: 06 October, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.