Search
Preparing search index...
The search index is not available
RAML JS Parser 2
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"node_modules/raml-definition-system/dist/definitionSystem.d"
UserDefinedProp
Class UserDefinedProp
Hierarchy
Property
UserDefinedProp
Implements
IProperty
IProperty
Index
Constructors
constructor
Properties
_display
Name
_enum
Options
_group
Name
_id
_key
Regexp
_key
Should
Start
From
_node
source
Provider
Methods
add
Adapter
add
Annotation
add
Child
Value
Constraint
annotations
can
BeValue
child
Restrictions
default
Value
described
Annotation
describes
Annotation
description
domain
enum
Options
get
Adapter
get
Adapters
get
Can
BeDuplicator
get
Child
Value
Constraints
get
Context
Requirements
get
Display
Name
get
Facet
Validator
get
Key
Regexp
get
Often
Keys
group
Name
id
inherited
Context
Value
is
Allow
Null
is
Annotation
is
Descriminator
is
From
Parent
Key
is
From
Parent
Value
is
Inherited
is
Key
is
Merged
is
Multi
Value
is
NoDirect
Parse
is
Primitive
is
Reference
is
Required
is
Self
Node
is
This
Property
Declares
Type
Fields
is
Value
Property
key
key
Prefix
match
Key
merge
name
Id
new
Instance
Name
node
range
references
To
remove
Annotation
set
Can
BeDuplicator
set
Default
Boolean
Val
set
Default
Integer
Val
set
Default
Val
set
Facet
Validator
set
Name
set
Source
Provider
set
Value
Doc
Provider
set
Value
Suggester
suggester
tags
unmerge
value
Doc
Provider
with
Allow
Null
with
Can
BeValue
with
Context
Requirement
with
Describes
with
Descriminating
with
Description
with
Display
Name
with
Domain
with
Enum
Options
with
From
Parent
Key
with
From
Parent
Value
with
Group
Name
with
Inherited
with
Inherited
Context
Value
with
Key
with
Key
Regexp
with
Key
Restriction
with
Multi
Value
with
New
Instance
Name
with
NoDirect
Parse
with
Often
Keys
with
Range
with
Required
with
Self
Node
with
This
Property
Declares
Fields
Constructors
constructor
new
User
Defined
Prop
(
name
:
string
, source
:
IParseResult
)
:
UserDefinedProp
Parameters
name:
string
source:
IParseResult
Returns
UserDefinedProp
Properties
_display
Name
_display
Name
:
string
Protected
_enum
Options
_enum
Options
:
string
[]
Protected
_group
Name
_group
Name
:
string
_id
_id
:
any
_key
Regexp
_key
Regexp
:
string
Protected
_key
Should
Start
From
_key
Should
Start
From
:
string
Private
_node
_node
:
any
Private
source
Provider
source
Provider
:
any
Methods
add
Adapter
add
Adapter
(
q
:
any
)
:
void
Parameters
q:
any
Returns
void
add
Annotation
add
Annotation
(
a
:
IAnnotation
)
:
void
Parameters
a:
IAnnotation
Returns
void
add
Child
Value
Constraint
add
Child
Value
Constraint
(
c
:
ChildValueConstraint
)
:
void
Parameters
c:
ChildValueConstraint
Returns
void
annotations
annotations
(
)
:
any
[]
Returns
any
[]
can
BeValue
can
BeValue
(
)
:
boolean
Returns
boolean
child
Restrictions
child
Restrictions
(
)
:
object
[]
Returns
object
[]
name
:
string
value
:
any
default
Value
default
Value
(
)
:
any
Returns
any
described
Annotation
described
Annotation
(
)
:
string
Returns
string
describes
Annotation
describes
Annotation
(
)
:
boolean
Returns
boolean
description
description
(
)
:
string
Returns
string
domain
domain
(
)
:
StructuredType
Returns
StructuredType
enum
Options
enum
Options
(
)
:
string
[]
Returns
string
[]
get
Adapter
get
Adapter<T>
(
adapterType
:
object
)
:
T
Type parameters
T
Parameters
adapterType:
object
constructor
:
function
new __type
(
p
?:
any
)
:
__type
Parameters
Optional
p:
any
Returns
__type
Returns
T
get
Adapters
get
Adapters
(
)
:
any
[]
Returns
any
[]
get
Can
BeDuplicator
get
Can
BeDuplicator
(
)
:
boolean
Returns
boolean
get
Child
Value
Constraints
get
Child
Value
Constraints
(
)
:
ChildValueConstraint
[]
Returns
ChildValueConstraint
[]
get
Context
Requirements
get
Context
Requirements
(
)
:
object
[]
Returns
object
[]
name
:
string
value
:
string
get
Display
Name
get
Display
Name
(
)
:
string
Returns
string
get
Facet
Validator
get
Facet
Validator
(
)
:
FacetValidator
Returns
FacetValidator
get
Key
Regexp
get
Key
Regexp
(
)
:
string
Returns
string
get
Often
Keys
get
Often
Keys
(
)
:
string
[]
Returns
string
[]
group
Name
group
Name
(
)
:
string
Returns
string
id
id
(
)
:
any
Returns
any
inherited
Context
Value
inherited
Context
Value
(
)
:
string
Returns
string
is
Allow
Null
is
Allow
Null
(
)
:
boolean
Returns
boolean
is
Annotation
is
Annotation
(
)
:
boolean
Returns
boolean
is
Descriminator
is
Descriminator
(
)
:
boolean
Returns
boolean
is
From
Parent
Key
is
From
Parent
Key
(
)
:
boolean
Returns
boolean
is
From
Parent
Value
is
From
Parent
Value
(
)
:
boolean
Returns
boolean
is
Inherited
is
Inherited
(
)
:
boolean
Returns
boolean
is
Key
is
Key
(
)
:
boolean
TODO THIS STUFF SHOULD BE MORE ABSTRACT (LATER...)
Returns
boolean
is
Merged
is
Merged
(
)
:
boolean
Returns
boolean
is
Multi
Value
is
Multi
Value
(
)
:
boolean
Returns
boolean
is
NoDirect
Parse
is
NoDirect
Parse
(
)
:
boolean
Returns
boolean
is
Primitive
is
Primitive
(
)
:
boolean
Returns
boolean
is
Reference
is
Reference
(
)
:
boolean
Returns
boolean
is
Required
is
Required
(
)
:
boolean
Returns
boolean
is
Self
Node
is
Self
Node
(
)
:
boolean
Returns
boolean
is
This
Property
Declares
Type
Fields
is
This
Property
Declares
Type
Fields
(
)
:
boolean
Returns
boolean
is
Value
Property
is
Value
Property
(
)
:
boolean
Returns
boolean
key
key
(
)
:
NamedId
Returns
NamedId
key
Prefix
key
Prefix
(
)
:
string
Returns
string
match
Key
match
Key
(
k
:
string
)
:
boolean
Parameters
k:
string
Returns
boolean
merge
merge
(
)
:
Property
Returns
Property
name
Id
name
Id
(
)
:
string
Returns
string
new
Instance
Name
new
Instance
Name
(
)
:
string
Returns
string
node
node
(
)
:
any
Returns
any
range
range
(
)
:
ITypeDefinition
Returns
ITypeDefinition
references
To
references
To
(
)
:
IType
Returns
IType
remove
Annotation
remove
Annotation
(
a
:
IAnnotation
)
:
void
Parameters
a:
IAnnotation
Returns
void
set
Can
BeDuplicator
set
Can
BeDuplicator
(
)
:
boolean
Returns
boolean
set
Default
Boolean
Val
set
Default
Boolean
Val
(
s
:
any
)
:
Property
Parameters
s:
any
Returns
Property
set
Default
Integer
Val
set
Default
Integer
Val
(
s
:
any
)
:
Property
Parameters
s:
any
Returns
Property
set
Default
Val
set
Default
Val
(
s
:
any
)
:
Property
Parameters
s:
any
Returns
Property
set
Facet
Validator
set
Facet
Validator
(
f
:
FacetValidator
)
:
void
Parameters
f:
FacetValidator
Returns
void
set
Name
set
Name
(
name
:
string
)
:
void
Parameters
name:
string
Returns
void
set
Source
Provider
set
Source
Provider
(
sourceProvider
:
SourceProvider
)
:
void
Parameters
sourceProvider:
SourceProvider
Returns
void
set
Value
Doc
Provider
set
Value
Doc
Provider
(
v
:
IValueDocProvider
)
:
Property
Parameters
v:
IValueDocProvider
Returns
Property
set
Value
Suggester
set
Value
Suggester
(
s
:
IValueSuggester
)
:
void
Parameters
s:
IValueSuggester
Returns
void
suggester
suggester
(
)
:
IValueSuggester
Returns
IValueSuggester
tags
tags
(
)
:
string
[]
Returns
string
[]
unmerge
unmerge
(
)
:
Property
Returns
Property
value
Doc
Provider
value
Doc
Provider
(
)
:
IValueDocProvider
Returns
IValueDocProvider
with
Allow
Null
with
Allow
Null
(
)
:
void
Returns
void
with
Can
BeValue
with
Can
BeValue
(
)
:
Property
Returns
Property
with
Context
Requirement
with
Context
Requirement
(
name
:
string
, value
:
string
)
:
void
Parameters
name:
string
value:
string
Returns
void
with
Describes
with
Describes
(
a
:
string
)
:
Property
Parameters
a:
string
Returns
Property
with
Descriminating
with
Descriminating
(
b
:
boolean
)
:
Property
Parameters
b:
boolean
Returns
Property
with
Description
with
Description
(
d
:
string
)
:
Described
Parameters
d:
string
Returns
Described
with
Display
Name
with
Display
Name
(
name
:
string
)
:
void
Parameters
name:
string
Returns
void
with
Domain
with
Domain
(
d
:
StructuredType
, custom
?:
boolean
)
:
Property
Parameters
d:
StructuredType
Optional
custom:
boolean
Returns
Property
with
Enum
Options
with
Enum
Options
(
op
:
string
[]
)
:
Property
Parameters
op:
string
[]
Returns
Property
with
From
Parent
Key
with
From
Parent
Key
(
v
?:
boolean
)
:
Property
Parameters
Optional
v:
boolean
Returns
Property
with
From
Parent
Value
with
From
Parent
Value
(
v
?:
boolean
)
:
Property
Parameters
Optional
v:
boolean
Returns
Property
with
Group
Name
with
Group
Name
(
gname
:
string
)
:
Property
Parameters
gname:
string
Returns
Property
with
Inherited
with
Inherited
(
w
:
boolean
)
:
void
Parameters
w:
boolean
Returns
void
with
Inherited
Context
Value
with
Inherited
Context
Value
(
v
:
string
)
:
Property
Parameters
v:
string
Returns
Property
with
Key
with
Key
(
isKey
:
boolean
)
:
Property
Parameters
isKey:
boolean
Returns
Property
with
Key
Regexp
with
Key
Regexp
(
regexp
:
string
)
:
Property
Parameters
regexp:
string
Returns
Property
with
Key
Restriction
with
Key
Restriction
(
keyShouldStartFrom
:
string
)
:
Property
Parameters
keyShouldStartFrom:
string
Returns
Property
with
Multi
Value
with
Multi
Value
(
v
?:
boolean
)
:
Property
Parameters
Optional
v:
boolean
Returns
Property
with
New
Instance
Name
with
New
Instance
Name
(
name
:
string
)
:
Property
Parameters
name:
string
Returns
Property
with
NoDirect
Parse
with
NoDirect
Parse
(
)
:
void
Returns
void
with
Often
Keys
with
Often
Keys
(
keys
:
string
[]
)
:
Property
Parameters
keys:
string
[]
Returns
Property
with
Range
with
Range
(
t
:
ITypeDefinition
)
:
Property
Parameters
t:
ITypeDefinition
Returns
Property
with
Required
with
Required
(
req
:
boolean
)
:
Property
Parameters
req:
boolean
Returns
Property
with
Self
Node
with
Self
Node
(
)
:
void
Returns
void
with
This
Property
Declares
Fields
with
This
Property
Declares
Fields
(
b
?:
boolean
)
:
Property
Parameters
Optional
b:
boolean
Returns
Property
Globals
"node_
modules/raml-
definition-
system/dist/definition
System.d"
IUniverse
Descriptor
IValue
Doc
Provider
IValue
Suggester
Universe
Provider
Value
Requirement
Array
IHas
Extra
IHigh
Level
Node
IParse
Result
IProperty
IType
IType
Definition
Named
DEFINED_
IN_
TYPES_
EXTRA
SOURCE_
EXTRA
TOP_
LEVEL_
EXTRA
USER_
DEFINED_
EXTRA
get
Universe
injector
ts
Interfaces
universes
Info
get
Schema
Utils
is
Source
Provider
prop
Generated using
TypeDoc
TODO THIS STUFF SHOULD BE MORE ABSTRACT (LATER...)