/mod.ts | fuzzy_octo_guacamole@v2.0.0

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

Namespaces

N P
N Pattern

Variables

v match	`match` creates a pattern matching expression.
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.bigint	`P.bigint` is a wildcard pattern matching any bigint.
v P.boolean	`P.boolean` is a wildcard pattern matching any boolean.
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.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.bigint	`P.bigint` is a wildcard pattern matching any bigint.
v Pattern.boolean	`P.boolean` is a wildcard pattern matching any boolean.
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.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 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.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.typed	`P.typed<SomeType>()` is a way to set the input type this pattern should match on.
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.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.typed	`P.typed<SomeType>()` is a way to set the input type this pattern should match on.
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

Type Aliases

T P.infer	`P.infer<typeof somePattern>` will return the type of the value matched by this pattern.
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 Pattern.infer	`P.infer<typeof somePattern>` will return the type of the value matched by this pattern.
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.