Skip to content

OptionsGuardOptions

Options for optionsGuard.

Import:

import type { OptionsGuardOptions } from '@mnaoumov/typescript-lib/api-contract';

Signature:

export interface OptionsGuardOptions

Properties

PropertyTypeDescription
description?stringWhat the options are, put before them in expected, e.g. 'select options'.
shouldRejectUnknownKeys?booleanWhether a value carrying an own enumerable string key that no option guard names is refused. Letting it through, the default, lets a consumer compiled against a later version of the options pass one this version does not know.

Links to this page: