parseDisplayOptions

Commons
stable

Merge caller-supplied display options with `DEFAULT_DISPLAY_OPTIONS` via a deep merge, returning a fully resolved `IInternalDisplayOptions` object ready to be consumed by the display composable.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

options
IDisplayOptions
DEFAULT_DISPLAY_OPTIONS
Partial display configuration supplied by the consumer. Falls back to `DEFAULT_DISPLAY_OPTIONS` when omitted.

API

Return value

The value returned by this util.

A fully resolved display options object with defaults filled in for every unspecified field.

Usage

Examples

Ready-to-paste usage snippets.

Resolve display options

typescript