Search
Preparing search index...
The search index is not available
@ckpack/parameter
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@ckpack/parameter
Parameter
Class Parameter
Hierarchy
Parameter
Index
Constructors
constructor
Properties
empty
Values
is
Coerce
Types
is
Remove
Additional
is
Use
Default
Methods
add
Rule
validate
Constructors
constructor
new
Parameter
(
options
?:
ParameterOptions
)
:
Parameter
Parameters
options:
ParameterOptions
= {}
Returns
Parameter
Properties
empty
Values
empty
Values
:
any
[]
is
Coerce
Types
is
Coerce
Types
:
Boolean
is
Remove
Additional
is
Remove
Additional
:
Boolean
is
Use
Default
is
Use
Default
:
Boolean
Methods
add
Rule
add
Rule
(
type
:
string
, checkRule
:
checkFunction
)
:
void
Parameters
type:
string
checkRule:
checkFunction
Returns
void
validate
validate
(
rules
:
{}
, params
?:
{}
, options
?:
ParameterOptions
)
:
null
|
Error
[]
Parameters
rules:
{}
[
key:
string
]:
Rules
|
string
params:
{}
= {}
[
key:
string
]:
any
options:
ParameterOptions
= {}
Returns
null
|
Error
[]
Exports
Parameter
constructor
empty
Values
is
Coerce
Types
is
Remove
Additional
is
Use
Default
add
Rule
validate
Generated using
TypeDoc