@novice1/api-doc-generator - v1.0.0
Preparing search index...
helpers/baseHelper
BaseHelperInterface
Interface BaseHelperInterface
interface
BaseHelperInterface
{
allowsEmptyValue
()
:
boolean
;
getDefaultValue
()
:
unknown
;
getDescription
()
:
string
;
getEnum
()
:
unknown
[]
;
getExampleValue
()
:
unknown
;
getMax
()
:
undefined
|
number
;
getMin
()
:
undefined
|
number
;
getType
()
:
string
;
getUnit
()
:
string
;
hasDefaultValue
()
:
boolean
;
hasExampleValue
()
:
boolean
;
hasMax
()
:
boolean
;
hasMin
()
:
boolean
;
isDeprecated
()
:
boolean
;
isRequired
()
:
boolean
;
isUnique
()
:
boolean
;
isValid
()
:
boolean
;
}
Hierarchy (
View Summary
)
BaseHelperInterface
OpenAPIHelperInterface
PostmanHelperInterface
Implemented by
JoiHelper
Index
Methods
allows
Empty
Value
get
Default
Value
get
Description
get
Enum
get
Example
Value
get
Max
get
Min
get
Type
get
Unit
has
Default
Value
has
Example
Value
has
Max
has
Min
is
Deprecated
is
Required
is
Unique
is
Valid
Methods
allows
Empty
Value
allowsEmptyValue
()
:
boolean
Returns
boolean
get
Default
Value
getDefaultValue
()
:
unknown
Returns
unknown
get
Description
getDescription
()
:
string
Returns
string
get
Enum
getEnum
()
:
unknown
[]
Returns
unknown
[]
get
Example
Value
getExampleValue
()
:
unknown
Returns
unknown
get
Max
getMax
()
:
undefined
|
number
Returns
undefined
|
number
get
Min
getMin
()
:
undefined
|
number
Returns
undefined
|
number
get
Type
getType
()
:
string
Returns
string
get
Unit
getUnit
()
:
string
Returns
string
has
Default
Value
hasDefaultValue
()
:
boolean
Returns
boolean
has
Example
Value
hasExampleValue
()
:
boolean
Returns
boolean
has
Max
hasMax
()
:
boolean
Returns
boolean
has
Min
hasMin
()
:
boolean
Returns
boolean
is
Deprecated
isDeprecated
()
:
boolean
Returns
boolean
is
Required
isRequired
()
:
boolean
Returns
boolean
is
Unique
isUnique
()
:
boolean
Returns
boolean
is
Valid
isValid
()
:
boolean
Returns
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
allows
Empty
Value
get
Default
Value
get
Description
get
Enum
get
Example
Value
get
Max
get
Min
get
Type
get
Unit
has
Default
Value
has
Example
Value
has
Max
has
Min
is
Deprecated
is
Required
is
Unique
is
Valid
@novice1/api-doc-generator - v1.0.0
Loading...