/mod.ts | fuzzy_octo_guacamole@v5.0.1

import * as fuzzyOctoGuacamole from "https://deno.land/x/fuzzy_octo_guacamole@v5.0.1/mod.ts";

Namespaces

N P
N Pattern

Variables

v P._	`P._` is a wildcard pattern, matching any value. It's an alias to `P.any`.
v P.any	`P.any` is a wildcard pattern, matching any value.
v P.between	`P.number.between(min, max)` matches number between `min` and `max`, equal to min or equal to max.
v P.betweenBigInt	`P.bigint.between(min, max)` matches bigint between `min` and `max`, equal to min or equal to max.
v P.bigint	`P.bigint` is a wildcard pattern, matching any bigint.
v P.boolean	`P.boolean` is a wildcard pattern, matching any boolean.
v P.finite	`P.number.finite` matches finite numbers.
v P.gt	`P.number.gt(min)` matches number greater than `min`.
v P.gtBigInt	`P.bigint.gt(min)` matches bigint greater than `min`.
v P.gte	`P.number.gte(min)` matches number greater than or equal to `min`.
v P.gteBigInt	`P.bigint.gte(min)` matches bigint greater than or equal to `min`.
v P.int	`P.number.int` matches integer numbers.
v P.lt	`P.number.lt(max)` matches number smaller than `max`.
v P.ltBigInt	`P.bigint.lt(max)` matches bigint smaller than `max`.
v P.lte	`P.number.lte(max)` matches number smaller than or equal to `max`.
v P.lteBigInt	`P.bigint.lte(max)` matches bigint smaller than or equal to `max`.
v P.matcher	Symbols used internally within ts-pattern to construct and discriminate Guard, Not, and Select, and AnonymousSelect patterns
v P.negative	`P.number.negative` matches negative numbers.
v P.negativeBigInt	`P.bigint.negative` matches negative bigints.
v P.nullish	`P.nullish` is a wildcard pattern, matching null or undefined.
v P.number	`P.number` is a wildcard pattern, matching any number.
v P.positive	`P.number.positive` matches positive numbers.
v P.positiveBigInt	`P.bigint.positive` matches positive bigints.
v P.string	`P.string` is a wildcard pattern, matching any string.
v P.symbol	`P.symbol` is a wildcard pattern, matching any symbol.
v Pattern._	`P._` is a wildcard pattern, matching any value. It's an alias to `P.any`.
v Pattern.any	`P.any` is a wildcard pattern, matching any value.
v Pattern.between	`P.number.between(min, max)` matches number between `min` and `max`, equal to min or equal to max.
v Pattern.betweenBigInt	`P.bigint.between(min, max)` matches bigint between `min` and `max`, equal to min or equal to max.
v Pattern.bigint	`P.bigint` is a wildcard pattern, matching any bigint.
v Pattern.boolean	`P.boolean` is a wildcard pattern, matching any boolean.
v Pattern.finite	`P.number.finite` matches finite numbers.
v Pattern.gt	`P.number.gt(min)` matches number greater than `min`.
v Pattern.gtBigInt	`P.bigint.gt(min)` matches bigint greater than `min`.
v Pattern.gte	`P.number.gte(min)` matches number greater than or equal to `min`.
v Pattern.gteBigInt	`P.bigint.gte(min)` matches bigint greater than or equal to `min`.
v Pattern.int	`P.number.int` matches integer numbers.
v Pattern.lt	`P.number.lt(max)` matches number smaller than `max`.
v Pattern.ltBigInt	`P.bigint.lt(max)` matches bigint smaller than `max`.
v Pattern.lte	`P.number.lte(max)` matches number smaller than or equal to `max`.
v Pattern.lteBigInt	`P.bigint.lte(max)` matches bigint smaller than or equal to `max`.
v Pattern.matcher	Symbols used internally within ts-pattern to construct and discriminate Guard, Not, and Select, and AnonymousSelect patterns
v Pattern.negative	`P.number.negative` matches negative numbers.
v Pattern.negativeBigInt	`P.bigint.negative` matches negative bigints.
v Pattern.nullish	`P.nullish` is a wildcard pattern, matching null or undefined.
v Pattern.number	`P.number` is a wildcard pattern, matching any number.
v Pattern.positive	`P.number.positive` matches positive numbers.
v Pattern.positiveBigInt	`P.bigint.positive` matches positive bigints.
v Pattern.string	`P.string` is a wildcard pattern, matching any string.
v Pattern.symbol	`P.symbol` is a wildcard pattern, matching any symbol.

Functions

f isMatching	`isMatching` takes pattern and returns a type guard function, cheching if a value matches this pattern.
f match	`match` creates a pattern matching expression. Use `.with(pattern, handler)` to pattern match on the input. Use `.exhaustive()` or `.otherwise(() => defaultValue)` to end the expression and get the result.
f P.array	`P.array(subpattern)` takes a sub pattern and returns a pattern, which matches arrays if all their elements match the sub pattern.
f P.instanceOf	`P.instanceOf(SomeClass)` is a pattern matching instances of a given class.
f P.intersection	`P.intersection(...patterns)` returns a pattern which matches only if every patterns provided in parameter match the input.
f P.map	`P.set(subpattern)` takes a sub pattern and returns a pattern that matches sets if all their elements match the sub pattern.
f P.not	`P.not(pattern)` returns a pattern which matches if the sub pattern doesn't match.
f P.optional	`P.optional(subpattern)` takes a sub pattern and returns a pattern which matches if the key is undefined or if it is defined and the sub pattern matches its value.
f P.select	`P.select()` is a pattern which will always match, and will inject the selected piece of input in the handler function.
f P.set	`P.set(subpattern)` takes a sub pattern and returns a pattern that matches sets if all their elements match the sub pattern.
f P.shape
f P.union	`P.union(...patterns)` returns a pattern which matches if at least one of the patterns provided in parameter match the input.
f P.when
f Pattern.array	`P.array(subpattern)` takes a sub pattern and returns a pattern, which matches arrays if all their elements match the sub pattern.
f Pattern.instanceOf	`P.instanceOf(SomeClass)` is a pattern matching instances of a given class.
f Pattern.intersection	`P.intersection(...patterns)` returns a pattern which matches only if every patterns provided in parameter match the input.
f Pattern.map	`P.set(subpattern)` takes a sub pattern and returns a pattern that matches sets if all their elements match the sub pattern.
f Pattern.not	`P.not(pattern)` returns a pattern which matches if the sub pattern doesn't match.
f Pattern.optional	`P.optional(subpattern)` takes a sub pattern and returns a pattern which matches if the key is undefined or if it is defined and the sub pattern matches its value.
f Pattern.select	`P.select()` is a pattern which will always match, and will inject the selected piece of input in the handler function.
f Pattern.set	`P.set(subpattern)` takes a sub pattern and returns a pattern that matches sets if all their elements match the sub pattern.
f Pattern.shape
f Pattern.union	`P.union(...patterns)` returns a pattern which matches if at least one of the patterns provided in parameter match the input.
f Pattern.when

Interfaces

I P.unstable_Fn
I Pattern.unstable_Fn

Type Aliases

T P.infer	`P.infer<typeof somePattern>` will return the type of the value matched by this pattern.
T P.matcher
T P.narrow
T P.Pattern	`Pattern<a>` is the generic type for patterns matching a value of type `a`. A pattern can be any (nested) javascript value.
T P.unstable_Matchable
T P.unstable_Matcher
T Pattern.infer	`P.infer<typeof somePattern>` will return the type of the value matched by this pattern.
T Pattern.matcher
T Pattern.narrow
T Pattern.Pattern	`Pattern<a>` is the generic type for patterns matching a value of type `a`. A pattern can be any (nested) javascript value.
T Pattern.unstable_Matchable
T Pattern.unstable_Matcher