Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/ui

Form.mask

Builds a bidirectional Schema codec from literal text and named slots.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Input codecs
Since
1.0.0
Member of
Form

Import

import { Form } from "@typed/ui";

Access Form.mask through the imported Form export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export declare function mask<const Parts extends ReadonlyArray<MaskPart>>(...parts: Parts): Schema.Codec<MaskValue<Parts>, string>;

Examples

import { mask, slot } from "@typed/ui/Form"
import { Schema } from "effect"

const phone = mask("(", slot("area", Schema.String, { length: 3 }), ") ",
  slot("number", Schema.String, { length: 7 }))

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source