Skip to content

unionGuard<const TGuards>

Builds a guard accepting what any of the given guards accepts, expecting their expected texts joined by or.

Import:

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

Signature:

function unionGuard(guards: TGuards): ExpectedTypeGuard<GuardedType<TGuards[number]["typeGuard"]>>

Parameters:

Parameter Type Description
guards TGuards The guards, tried in order.

Returns: ExpectedTypeGuard<GuardedType<TGuards[number][“typeGuard”]>> — The guard.