Search
Preparing search index...
The search index is not available
TypeDoc Pages Plugin
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Home
Options
OptionValidator
Class OptionValidator
Helper class for validating plugin options
Hierarchy
OptionValidator
Index
Methods
_validate
Group
_validate
Page
_validate
Page
OrSection
_validate
Section
validate
Methods
Private
_validate
Group
_validate
Group
(
definition
:
PageGroupDefinition
, sourcePrefix
:
string
)
:
void
Parameters
definition:
PageGroupDefinition
sourcePrefix:
string
Returns
void
Private
_validate
Page
_validate
Page
(
definition
:
PageDefinition
|
ChildPageDefinition
, sourcePrefix
:
string
, isChild
:
boolean
)
:
void
Parameters
definition:
PageDefinition
|
ChildPageDefinition
sourcePrefix:
string
isChild:
boolean
Returns
void
Private
_validate
Page
OrSection
_validate
Page
OrSection
(
definition
:
PageDefinition
|
ChildPageDefinition
|
PageSectionDefinition
, sourcePrefix
:
string
, isChild
:
boolean
)
:
void
Parameters
definition:
PageDefinition
|
ChildPageDefinition
|
PageSectionDefinition
sourcePrefix:
string
isChild:
boolean
Returns
void
Private
_validate
Section
_validate
Section
(
definition
:
PageSectionDefinition
, sourcePrefix
:
string
)
:
void
Parameters
definition:
PageSectionDefinition
sourcePrefix:
string
Returns
void
validate
validate
(
options
:
PluginOptions
)
:
void
Parameters
options:
PluginOptions
Returns
void
Getting
Started
Quick
Start
Creating
Pages
Page
Organization
Configuration
Configuration
File
Reflection
Navigation
Title
Search
Integration
Advanced
Content
Images
Code
Links
Page
Links
Themes
Built-
In
Theme
Custom
Themes
Development API
Constants
Links
Models
Options
Pages
Plugin
Rendering
Search
Theme
Utilities
Child
Page
Definition
Page
Definition
Page
Group
Definition
Page
Section
Definition
Plugin
Options
Option
Manager
Option
Validator
_validate
Group
_validate
Page
_validate
Page
OrSection
_validate
Section
validate
Child
Page
Definition
Page
Definition
Page
Group
Definition
Page
Section
Definition
Plugin
Options
default
Option
And
Validate
IsArray
default
Option
And
Validate
IsBoolean
default
Option
And
Validate
IsString
default
Option
IfUndefined
validate
Option
IsArray
validate
Option
IsBoolean
validate
Option
IsString
Generated using
TypeDoc
Helper class for validating plugin options