Interface Options

🧰 type util

$Never.$Options enables customizing the behavior of the $never branch.

The $never branch is used to handle when the input type is never.

Example

type YourType<
  T,
  $Options extends YourType.$Options = YourType.$Default
> = ...

namespace YourType {
  export type $Options = $Never.$Options
  export type $Branch = $Never.$Branch
}
interface Options {
    $array?: unknown;
    $emptyTuple?: unknown;
    $never?: unknown;
    $notMatch?: unknown;
    $unionNotMatch?: unknown;
    $widen?: unknown;
    widen?: boolean;
}

Hierarchy (view full)

Properties

$array? $emptyTuple? $never? $notMatch? $unionNotMatch? $widen? widen?

Properties

Optional$array

$array?: unknown

Optional$emptyTuple

$emptyTuple?: unknown

Optional$never

$never?: unknown

Optional$notMatch

$notMatch?: unknown

Optional$unionNotMatch

$unionNotMatch?: unknown

Optional$widen

$widen?: unknown

Optionalwiden

widen?: boolean

Settings

Member Visibility

On This Page

Properties