ExamplesAction

Examples metadata action.

Generics

• TInput extends any
• TExamples extends readonly TInput[]

Definition

• ExamplesAction extends BaseMetadata<TInput>
  • type 'examples'
  • reference typeof examples
  • examples TExamples

Related

The following APIs can be combined with ExamplesAction.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• custom,
• date,
• enum,
• exactOptional,
• file,
• function,
• instance,
• intersect,
• lazy,
• literal,
• looseObject,
• looseTuple,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null,
• nullable,
• nullish,
• number,
• object,
• objectWithRest,
• optional,
• picklist,
• promise,
• record,
• set,
• strictObject,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• undefinedable,
• union,
• unknown,
• variant,
• void

Methods

• getExamples,
• pipe

Actions

• examples