Property | RAML JS Parser 2

Hierarchy

Property
- Property
  - UserDefinedProp

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new Property(_name: string, _description?: string): Property

Inherited from Described.constructor

Overwrites Adaptable.constructor
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:30
Parameters
- _name: string
- Optional _description: string
Returns Property

Properties

Private _allowsNull

_allowsNull: any

Private _canBeDuplicator

_canBeDuplicator: any

Private _canBeValue

_canBeValue: any

Private _contextReq

_contextReq: any

Private _declaresFields

_declaresFields: any

Private _describes

_describes: any

Protected _enumOptions

_enumOptions: string[]

Protected _groupName

_groupName: string

_id

_id: any

Private _inheritsValueFromContext

_inheritsValueFromContext: any

Private _isFromParentKey

_isFromParentKey: any

Private _isFromParentValue

_isFromParentValue: any

Private _isInherited

_isInherited: any

Private _key

_key: any

_keyRegexp

_keyRegexp: string

Protected _keyShouldStartFrom

_keyShouldStartFrom: string

Private _newInstanceName

_newInstanceName: any

Private _noDirectParse

_noDirectParse: any

Private _oftenKeys

_oftenKeys: any

Private _selfNode

_selfNode: any

Private _suggester

_suggester: any

Private _vprovider

_vprovider: any

Private determinesChildValues

determinesChildValues: any

Methods

addAdapter

addAdapter(q: any): void

Inherited from Adaptable.addAdapter
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:21
Parameters
- q: any
Returns void

addAnnotation

addAnnotation(a: IAnnotation): void

Implementation of IProperty.addAnnotation

Inherited from Described.addAnnotation
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:37
Parameters
- a: IAnnotation
Returns void

addChildValueConstraint

addChildValueConstraint(c: ChildValueConstraint): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:171
Parameters
- c: ChildValueConstraint
Returns void

annotations

annotations(): any[]

Implementation of IProperty.annotations

Inherited from Described.annotations
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:39
Returns any[]

canBeValue

canBeValue(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:150
Returns boolean

childRestrictions

childRestrictions(): object[]

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:173
Returns object[]
- name: string
- value: any

defaultValue

defaultValue(): any

Implementation of IProperty.defaultValue

Inherited from Property.defaultValue
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:212
Returns any

describedAnnotation

describedAnnotation(): string

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:162
Returns string

describesAnnotation

describesAnnotation(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:161
Returns boolean

description

description(): string

Implementation of IProperty.description

Inherited from Described.description
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:33
Returns string

domain

domain(): StructuredType

Implementation of IProperty.domain

Inherited from Property.domain
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:226
Returns StructuredType

enumOptions

enumOptions(): string[]

Implementation of IProperty.enumOptions

Overwrites Property.enumOptions
- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:141
Returns string[]

getAdapter

getAdapter<T>(adapterType: object): T

Inherited from Adaptable.getAdapter
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:23
Type parameters
- T
Parameters
- adapterType: object
  - constructor: function
    - new __type(p?: any): __type
    - Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:23
      Parameters
      - Optional p: any
      Returns __type
Returns T

getAdapters

getAdapters(): any[]

Implementation of IProperty.getAdapters

Inherited from Adaptable.getAdapters
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:26
Returns any[]

getCanBeDuplicator

getCanBeDuplicator(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:149
Returns boolean

getChildValueConstraints

getChildValueConstraints(): ChildValueConstraint[]

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:172
Returns ChildValueConstraint[]

getContextRequirements

getContextRequirements(): object[]

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:156
Returns object[]
- name: string
- value: string

getFacetValidator

getFacetValidator(): FacetValidator

Inherited from Property.getFacetValidator
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:224
Returns FacetValidator

getKeyRegexp

getKeyRegexp(): string

Implementation of IProperty.getKeyRegexp

Inherited from Property.getKeyRegexp
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:221
Returns string

getOftenKeys

getOftenKeys(): string[]

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:142
Returns string[]

groupName

groupName(): string

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:195
Returns string

id

id(): any

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:178
Returns any

inheritedContextValue

inheritedContextValue(): string

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:152
Returns string

isAllowNull

isAllowNull(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:147
Returns boolean

isAnnotation

isAnnotation(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:179
Returns boolean

isDescriminator

isDescriminator(): boolean

Implementation of IProperty.isDescriminator

Inherited from Property.isDescriminator
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:229
Returns boolean

isFromParentKey

isFromParentKey(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:182
Returns boolean

isFromParentValue

isFromParentValue(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:183
Returns boolean

isInherited

isInherited(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:146
Returns boolean

isKey

isKey(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:193
TODO THIS STUFF SHOULD BE MORE ABSTRACT (LATER...)

Returns boolean

isMerged

isMerged(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:194
Returns boolean

isMultiValue

isMultiValue(): boolean

Implementation of IProperty.isMultiValue

Inherited from Property.isMultiValue
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:228
Returns boolean

isNoDirectParse

isNoDirectParse(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:133
Returns boolean

isPrimitive

isPrimitive(): boolean

Implementation of IProperty.isPrimitive

Overwrites Property.isPrimitive
- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:131
Returns boolean

isReference

isReference(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:164
Returns boolean

isRequired

isRequired(): boolean

Implementation of IProperty.isRequired

Inherited from Property.isRequired
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:206
Returns boolean

isSelfNode

isSelfNode(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:135
Returns boolean

isThisPropertyDeclaresTypeFields

isThisPropertyDeclaresTypeFields(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:168
Returns boolean

isValueProperty

isValueProperty(): boolean

Implementation of IProperty.isValueProperty

Inherited from Property.isValueProperty
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:215
Returns boolean

key

key(): NamedId

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:196
Returns NamedId

keyPrefix

keyPrefix(): string

Implementation of IProperty.keyPrefix

Inherited from Property.keyPrefix
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:217
Returns string

matchKey

matchKey(k: string): boolean

Implementation of IProperty.matchKey

Overwrites Property.matchKey
- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:136
Parameters
- k: string
Returns boolean

merge

merge(): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:186
Returns Property

nameId

nameId(): string

Implementation of IProperty.nameId

Inherited from Described.nameId
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:32
Returns string

newInstanceName

newInstanceName(): string

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:166
Returns string

range

range(): ITypeDefinition

Implementation of IProperty.range

Inherited from Property.range
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:227
Returns ITypeDefinition

referencesTo

referencesTo(): IType

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:165
Returns IType

removeAnnotation

removeAnnotation(a: IAnnotation): void

Implementation of IProperty.removeAnnotation

Inherited from Described.removeAnnotation
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:38
Parameters
- a: IAnnotation
Returns void

setCanBeDuplicator

setCanBeDuplicator(): boolean

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:151
Returns boolean

setDefaultBooleanVal

setDefaultBooleanVal(s: any): Property

Inherited from Property.setDefaultBooleanVal
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:210
Parameters
- s: any
Returns Property

setDefaultIntegerVal

setDefaultIntegerVal(s: any): Property

Inherited from Property.setDefaultIntegerVal
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:211
Parameters
- s: any
Returns Property

setDefaultVal

setDefaultVal(s: any): Property

Inherited from Property.setDefaultVal
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:209
Parameters
- s: any
Returns Property

setFacetValidator

setFacetValidator(f: FacetValidator): void

Inherited from Property.setFacetValidator
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:225
Parameters
- f: FacetValidator
Returns void

setName

setName(name: string): void

Inherited from Described.setName
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:42
Parameters
- name: string
Returns void

setValueDocProvider

setValueDocProvider(v: IValueDocProvider): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:138
Parameters
- v: IValueDocProvider
Returns Property

setValueSuggester

setValueSuggester(s: IValueSuggester): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:140
Parameters
- s: IValueSuggester
Returns void

suggester

suggester(): IValueSuggester

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:139
Returns IValueSuggester

unmerge

unmerge(): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:185
Returns Property

valueDocProvider

valueDocProvider(): IValueDocProvider

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:137
Returns IValueDocProvider

withAllowNull

withAllowNull(): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:148
Returns void

withCanBeValue

withCanBeValue(): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:144
Returns Property

withContextRequirement

withContextRequirement(name: string, value: string): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:155
Parameters
- name: string
- value: string
Returns void

withDescribes

withDescribes(a: string): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:160
Parameters
- a: string
Returns Property

withDescriminating

withDescriminating(b: boolean): Property

Inherited from Property.withDescriminating
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:204
Parameters
- b: boolean
Returns Property

withDescription

withDescription(d: string): Described

Inherited from Described.withDescription
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:41
Parameters
- d: string
Returns Described

withDomain

withDomain(d: StructuredType, custom?: boolean): Property

Inherited from Property.withDomain
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:208
Parameters
- d: StructuredType
- Optional custom: boolean
Returns Property

withEnumOptions

withEnumOptions(op: string[]): Property

Inherited from Property.withEnumOptions
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:218
Parameters
- op: string[]
Returns Property

withFromParentKey

withFromParentKey(v?: boolean): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:181
Parameters
- Optional v: boolean
Returns Property

withFromParentValue

withFromParentValue(v?: boolean): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:180
Parameters
- Optional v: boolean
Returns Property

withGroupName

withGroupName(gname: string): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:184
Parameters
- gname: string
Returns Property

withInherited

withInherited(w: boolean): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:145
Parameters
- w: boolean
Returns void

withInheritedContextValue

withInheritedContextValue(v: string): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:153
Parameters
- v: string
Returns Property

withKey

withKey(isKey: boolean): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:187
Parameters
- isKey: boolean
Returns Property

withKeyRegexp

withKeyRegexp(regexp: string): Property

Inherited from Property.withKeyRegexp
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:220
Parameters
- regexp: string
Returns Property

withKeyRestriction

withKeyRestriction(keyShouldStartFrom: string): Property

Inherited from Property.withKeyRestriction
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:207
Parameters
- keyShouldStartFrom: string
Returns Property

withMultiValue

withMultiValue(v?: boolean): Property

Inherited from Property.withMultiValue
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:203
Parameters
- Optional v: boolean
Returns Property

withNewInstanceName

withNewInstanceName(name: string): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:169
Parameters
- name: string
Returns Property

withNoDirectParse

withNoDirectParse(): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:132
Returns void

withOftenKeys

withOftenKeys(keys: string[]): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:143
Parameters
- keys: string[]
Returns Property

withRange

withRange(t: ITypeDefinition): Property

Inherited from Property.withRange
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:214
Parameters
- t: ITypeDefinition
Returns Property

withRequired

withRequired(req: boolean): Property

Inherited from Property.withRequired
- Defined in node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/nominal-types.d.ts:205
Parameters
- req: boolean
Returns Property

withSelfNode

withSelfNode(): void

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:134
Returns void

withThisPropertyDeclaresFields

withThisPropertyDeclaresFields(b?: boolean): Property

- Defined in node_modules/raml-definition-system/dist/definitionSystem.d.ts:167
Parameters
- Optional b: boolean
Returns Property

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_name: string

Optional _description: string

Returns Property

Properties

Private _allowsNull

Private _canBeDuplicator

Private _canBeValue

Private _contextReq

Private _declaresFields

Private _describes

Protected _enumOptions

Protected _groupName

_id

Private _inheritsValueFromContext

Private _isFromParentKey

Private _isFromParentValue

Private _isInherited

Private _key

_keyRegexp

Protected _keyShouldStartFrom

Private _newInstanceName

Private _noDirectParse

Private _oftenKeys

Private _selfNode

Private _suggester

Private _vprovider

Private determinesChildValues

Methods

addAdapter

Parameters

q: any

Returns void

addAnnotation

Parameters

a: IAnnotation

Returns void

addChildValueConstraint

Parameters

c: ChildValueConstraint

Returns void

annotations

Returns any[]

canBeValue

Returns boolean

childRestrictions

Returns object[]

name: string

value: any

defaultValue

Returns any

describedAnnotation

Returns string

describesAnnotation

Returns boolean

description

Returns string

domain

Returns StructuredType

enumOptions

Returns string[]

getAdapter

Type parameters

T

Parameters

adapterType: object

constructor: function

Parameters

Optional p: any

Returns __type

Returns T

getAdapters