@wollybeard/kit

Appearance

Ts.Assert.sub ​

Import ​

typescript
import { Ts } from '@wollybeard/kit'

// Access via namespace
Ts.Assert.sub
typescript
import { sub } from '@wollybeard/kit/ts'

Functions ​

[F] noExcessAs
​

typescript
<$Type>(): DispatchAfterInput<State.SetExpectedType<State.SetRelator<State.SetRelator<State.Empty, SubKind>, SubNoExcessKind>, $Type>>

[F] ofAs
​

typescript
<$Type>(): DispatchAfterInput<State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, $Type>>

Constants ​

[C] any
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<
    State.SetAllowAny<State.SetRelator<State.Empty, SubKind>>,
    any
  >
>

[C] bigint
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, bigint>
>

[C] boolean
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, boolean>
>

[C] Date
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, Date>
>

[C] Error
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, Error>
>

[C] false
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, false>
>

[C] never
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<
    State.SetAllowNever<State.SetRelator<State.Empty, SubKind>>,
    never
  >
>

[C] noExcess
​

typescript
InputExpectedAsValueNarrow<
  State.SetRelator<State.SetRelator<State.Empty, SubKind>, SubNoExcessKind>
>

[C] null
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, null>
>

[C] number
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, number>
>

[C] of
​

typescript
InputExpectedAsValueNarrow<State.SetRelator<State.Empty, SubKind>>

[C] RegExp
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, RegExp>
>

[C] string
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, string>
>

[C] symbol
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, symbol>
>

[C] true
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, true>
>

[C] undefined
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<State.SetRelator<State.Empty, SubKind>, undefined>
>

[C] unknown
​

typescript
InputActualAsValueNarrow<
  State.SetExpectedType<
    State.SetAllowUnknown<State.SetRelator<State.Empty, SubKind>>,
    unknown
  >
>

Types ​

[T] any
​

typescript
type any_<$Actual> = Kind.Apply<SubKind, [any, $Actual]>

Pre-curried matcher for any.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
any
<any>

// ✗ Fail
type 
_
 = Assert.sub.
any
<string>

[T] bigint
​

typescript
type bigint_<$Actual> = Kind.Apply<SubKind, [bigint, $Actual]>

Pre-curried matcher for bigint.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
bigint
<bigint>

// ✗ Fail
type 
_
 = Assert.sub.
bigint
<string>

[T] boolean
​

typescript
type boolean_<$Actual> = Kind.Apply<SubKind, [boolean, $Actual]>

Pre-curried matcher for boolean.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
boolean
<boolean>

// ✗ Fail
type 
_
 = Assert.sub.
boolean
<string>

[T] Date
​

typescript
type Date_<$Actual> = Kind.Apply<SubKind, [Date, $Actual]>

Pre-curried matcher for Date.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
Date
<Date>

// ✗ Fail
type 
_
 = Assert.sub.
Date
<string>

[T] Error
​

typescript
type Error_<$Actual> = Kind.Apply<SubKind, [Error, $Actual]>

Pre-curried matcher for Error.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
Error
<Error>

// ✗ Fail
type 
_
 = Assert.sub.
Error
<string>

[T] false
​

typescript
type false_<$Actual> = Kind.Apply<SubKind, [false, $Actual]>

Pre-curried matcher for false literal.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
false
<false>

// ✗ Fail
type 
_
 = Assert.sub.
false
<true>

[T] never
​

typescript
type never_<$Actual> = Kind.Apply<SubKind, [never, $Actual]>

Pre-curried matcher for never.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
never
<never>

// ✗ Fail
type 
_
 = Assert.sub.
never
<string>

[T] noExcess
​

typescript
type noExcess_<$Expected, $Actual> = Kind.Apply<
  SubNoExcessKind,
  [$Expected, $Actual]
>

No-excess variant of sub relation. Checks that actual has no excess properties beyond expected.

[T] null
​

typescript
type null_<$Actual> = Kind.Apply<SubKind, [null, $Actual]>

Pre-curried matcher for null.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
null
<null>

// ✗ Fail
type 
_
 = Assert.sub.
null
<string>

[T] number
​

typescript
type number_<$Actual> = Kind.Apply<SubKind, [number, $Actual]>

Pre-curried matcher for number.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
number
<number>

// ✗ Fail
type 
_
 = Assert.sub.
number
<string>

[T] of
​

typescript
type of_<$Expected, $Actual> = Kind.Apply<SubKind, [$Expected, $Actual]>

base + sub relation matchers.

Direct type assertion Relation: subtype relation (extends)

[T] RegExp
​

typescript
type RegExp_<$Actual> = Kind.Apply<SubKind, [RegExp, $Actual]>

Pre-curried matcher for RegExp.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
RegExp
<RegExp>

// ✗ Fail
type 
_
 = Assert.sub.
RegExp
<string>

[T] string
​

typescript
type string_<$Actual> = Kind.Apply<SubKind, [string, $Actual]>

Pre-curried matcher for string.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
string
<string>

// ✗ Fail
type 
_
 = Assert.sub.
string
<number>

[T] symbol
​

typescript
type symbol_<$Actual> = Kind.Apply<SubKind, [symbol, $Actual]>

Pre-curried matcher for symbol.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
symbol
<symbol>

// ✗ Fail
type 
_
 = Assert.sub.
symbol
<string>

[T] true
​

typescript
type true_<$Actual> = Kind.Apply<SubKind, [true, $Actual]>

Pre-curried matcher for true literal.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
true
<true>

// ✗ Fail
type 
_
 = Assert.sub.
true
<false>

[T] undefined
​

typescript
type undefined_<$Actual> = Kind.Apply<SubKind, [undefined, $Actual]>

Pre-curried matcher for undefined.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
undefined
<undefined>

// ✗ Fail
type 
_
 = Assert.sub.
undefined
<string>

[T] unknown
​

typescript
type unknown_<$Actual> = Kind.Apply<SubKind, [unknown, $Actual]>

Pre-curried matcher for unknown.

Examples:

typescript
// ✓ Pass
type 
_
 = Assert.sub.
unknown
<unknown>

// ✗ Fail
type 
_
 = Assert.sub.
unknown
<string>