Interface MatchCompiledSchema<TPattern>

interface MatchCompiledSchema<TPattern extends MatchPattern> {
    pattern: TPattern;
    parse(input: unknown): InferMatchPattern<TPattern>;
    test(input: unknown): input is InferMatchPattern<TPattern>;
    toJSONSchema(options?: MatchToJsonSchemaOptions): MatchJsonSchema;
}

Type Parameters

TPattern extends MatchPattern

Hierarchy (View Summary)

CheckSchemaLike<InferMatchPattern<TPattern>>
- MatchCompiledSchema

Index

Properties

Methods

parse test toJSONSchema

Properties

`Readonly`pattern

pattern: TPattern

Methods

parse

parse(input: unknown): InferMatchPattern<TPattern>
Parameters
- input: unknown
Returns InferMatchPattern<TPattern>
Overrides CheckSchemaLike.parse
- Defined in src/tools/check/types.ts:238

test

test(input: unknown): input is InferMatchPattern<TPattern>
Parameters
- input: unknown
Returns input is InferMatchPattern<TPattern>
- Defined in src/tools/check/types.ts:239

toJSONSchema

toJSONSchema(options?: MatchToJsonSchemaOptions): MatchJsonSchema
Parameters
- Optionaloptions: MatchToJsonSchemaOptions
Returns MatchJsonSchema
Overrides CheckSchemaLike.toJSONSchema
- Defined in src/tools/check/types.ts:240