@bluelibs/runner - v6.3.1
Preparing search index...
Match
Variable Match
Const
Match
:
Readonly
<
{
Any
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.Any"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
unknown
;
test
(
value
:
unknown
)
:
value
is
unknown
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
ArrayOf
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
=>
readonly
[
TPattern
]
;
Class
:
(
options
?:
MatchSchemaOptions
)
=>
MatchSchemaDecorator
;
compile
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
=>
MatchCompiledSchema
<
TPattern
>
;
Email
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.Email"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
string
;
test
(
value
:
unknown
)
:
value
is
string
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
Field
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
=>
MatchPropertyDecorator
;
fromClass
:
{
<
TClass
extends
MatchSchemaClass
>
(
target
:
TClass
,
options
?:
MatchSchemaOptions
,
)
:
ClassPattern
<
TClass
>
;
<
TClass
extends
MatchSchemaClass
>
(
target
:
MatchSchemaResolver
<
TClass
>
,
options
?:
MatchSchemaOptions
,
)
:
LazyPattern
<
ClassPattern
<
TClass
>
>
;
}
;
fromSchema
:
{
<
TClass
extends
MatchSchemaClass
>
(
target
:
TClass
,
options
?:
MatchSchemaOptions
,
)
:
ClassPattern
<
TClass
>
;
<
TClass
extends
MatchSchemaClass
>
(
target
:
MatchSchemaResolver
<
TClass
>
,
options
?:
MatchSchemaOptions
,
)
:
LazyPattern
<
ClassPattern
<
TClass
>
>
;
}
;
Integer
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.Integer"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
number
;
test
(
value
:
unknown
)
:
value
is
number
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
IsoDateString
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.IsoDateString"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
string
;
test
(
value
:
unknown
)
:
value
is
string
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
Lazy
:
<
TPattern
extends
MatchPattern
>
(
resolver
:
()
=>
TPattern
,
)
=>
LazyPattern
<
TPattern
>
;
MapOf
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
=>
MapOfPattern
<
TPattern
>
;
Maybe
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
=>
MaybePattern
<
TPattern
>
;
NonEmptyArray
:
{
()
:
NonEmptyArrayPattern
<
undefined
>
;
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
:
NonEmptyArrayPattern
<
TPattern
>
;
}
;
NonEmptyString
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.NonEmptyString"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
string
;
test
(
value
:
unknown
)
:
value
is
string
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
ObjectIncluding
:
<
const
TObjectPattern
extends
Record
<
string
,
unknown
>
>
(
pattern
:
TObjectPattern
,
)
=>
ObjectIncludingPattern
<
TObjectPattern
>
;
ObjectStrict
:
<
const
TObjectPattern
extends
Record
<
string
,
unknown
>
>
(
pattern
:
TObjectPattern
,
)
=>
ObjectStrictPattern
<
TObjectPattern
>
;
OneOf
:
<
const
TPatterns
extends
readonly
MatchPattern
[]
>
(
...
patterns
:
TPatterns
,
)
=>
OneOfPattern
<
TPatterns
>
;
Optional
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
)
=>
OptionalPattern
<
TPattern
>
;
PositiveInteger
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.PositiveInteger"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
number
;
test
(
value
:
unknown
)
:
value
is
number
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
Range
:
(
options
:
{
inclusive
?:
boolean
;
integer
?:
boolean
;
max
?:
number
;
min
?:
number
;
}
,
)
=>
RangePattern
;
RegExp
:
(
expression
:
string
|
RegExp
)
=>
RegExpPattern
<
RegExp
>
;
Schema
:
(
options
?:
MatchSchemaOptions
)
=>
MatchSchemaDecorator
;
test
:
<
TPattern
extends
MatchPattern
>
(
value
:
unknown
,
pattern
:
TPattern
,
)
=>
value
is
InferMatchPattern
<
TPattern
>
;
toJSONSchema
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
options
?:
MatchToJsonSchemaOptions
,
)
=>
MatchJsonSchema
;
URL
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.URL"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
string
;
test
(
value
:
unknown
)
:
value
is
string
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
UUID
:
Readonly
<
{
appliesMessageOverrideToAggregate
:
()
=>
boolean
;
compileToJSONSchema
:
(
context
:
CompileContext
,
path
:
string
,
mode
:
CompileMode
,
compilePattern
:
MatchJsonSchemaCompiler
,
)
=>
MatchJsonSchema
;
isOptionalObjectProperty
:
()
=>
boolean
;
kind
:
"Match.UUID"
;
match
:
(
value
:
unknown
,
context
:
MatchContext
,
path
:
readonly
PathSegment
[]
,
parent
:
unknown
,
matchesPattern
:
MatchPatternMatcher
,
)
=>
boolean
;
parse
(
value
:
unknown
)
:
string
;
test
(
value
:
unknown
)
:
value
is
string
;
toJSONSchema
(
options
?:
MatchToJsonSchemaOptions
)
:
MatchJsonSchema
;
}
,
>
;
Where
:
{
<
TGuarded
>
(
condition
:
WhereTypeGuard
<
TGuarded
>
,
)
:
WherePattern
<
TGuarded
>
;
<
TGuarded
>
(
condition
:
WhereTypeGuard
<
TGuarded
>
,
message
:
MatchMessageOptions
<
WherePattern
<
TGuarded
>
>
,
)
:
WithMessagePattern
<
WherePattern
<
TGuarded
>
>
;
(
condition
:
WherePredicate
)
:
WherePattern
<
unknown
>
;
(
condition
:
WherePredicate
,
message
:
MatchMessageOptions
<
WherePattern
<
unknown
>
>
,
)
:
WithMessagePattern
<
WherePattern
<
unknown
>
>
;
}
;
WithErrorPolicy
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
errorPolicy
:
"first"
|
"all"
,
)
=>
WithErrorPolicyPattern
<
TPattern
>
;
WithMessage
:
<
TPattern
extends
MatchPattern
>
(
pattern
:
TPattern
,
message
:
MatchMessageOptions
<
TPattern
>
,
)
=>
WithMessagePattern
<
TPattern
>
;
}
,
>
= ...
Validation and pattern-matching toolkit used by schema-aware Runner APIs.
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@bluelibs/runner - v6.3.1
Loading...
Validation and pattern-matching toolkit used by schema-aware Runner APIs.