🧰 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.

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

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

Hierarchy (view full)

Properties

$never?: unknown
$notMatch?: unknown
$tuple?: unknown
$unionNotMatch?: unknown
$widen?: unknown
widen?: boolean