resolvePlaygroundOption · API

Resolves an option of a playground property. A named option (an enum member) carries its value; a plain value from the playground's controls is the value itself; any other option is the source text of a union member, such as 'small', and is evaluated; it throws when that text can't be evaluated.

DeclarationTypeScript

function resolvePlaygroundOption(
  option: string | NgDocPlaygroundOption,
  isManual?: boolean | undefined,
): NgDocResolvedPlaygroundOption;

Returns

NgDocResolvedPlaygroundOption -

The value of the option and the text that shows it.

Parameters

Name	Type	Description
option	`string \| NgDocPlaygroundOption`	The option.
isManual	`boolean \| undefined`	Whether the options come from the playground's `controls`.

Symbol

Kind: Function
Scope: @ng-doc/app

Edit this page