/core/is.ts | typeguardkit@0.32.1

Module

x/typeguardkit/core/is.ts

A TypeScript module to help construct type assertion functions and type guards.

antonebbage/typeguardkit

Latest

object_asserter

mod.ts (default module)

ObjectIntersectionAsserter

NumberAsserterOptions

NumberAsserterRule

StringAsserterOptions

StringAsserterRegex

StringAsserterRule

TypeAssertionErrorOptions

literal_union_asserter.ts

NumberAsserterOptions

StringAsserterOptions

type_assertion_error.ts

TypeAssertionError

TypeAssertionErrorOptions

import * as typeguardkit from "https://deno.land/x/typeguardkit@0.32.1/core/is.ts";

Functions

f is	`is` wraps `asserter` with a predicate signature, creating a type guard, so that `value` can be narrowed to `Type`. If `asserter.assert` throws an error, `is` will catch it and return `false`. Otherwise, `is` will return `true`.