WebApiVocabulary | webapi-parser

Subclass of Vocabulary inheriting WebApiBaseUnit utility methods.

Hierarchy

WebApiBaseUnit
- WebApiVocabulary

Index

Properties

Methods

Properties

base

description

description: StrField

externals

externals: External[]

id

id: string

imports

imports: VocabularyReference[]

location

location: string

name

raw

raw: string | undefined

usage

usage: StrField

Methods

classTerms

classTerms(): ClassTerm[]

- Defined in webapi-parser.d.ts:120
Returns ClassTerm[]

datatypePropertyTerms

datatypePropertyTerms(): DatatypePropertyTerm[]

- Defined in webapi-parser.d.ts:118
Returns DatatypePropertyTerm[]

findById

findById(id: string): DomainElement | undefined

Inherited from BaseUnit.findById
- Defined in amf-client-js.d.ts:496
Parameters
- id: string
Returns DomainElement | undefined

findByType

findByType(typeId: string): DomainElement[]

Inherited from BaseUnit.findByType
- Defined in amf-client-js.d.ts:498
Parameters
- typeId: string
Returns DomainElement[]

getDeclarationByName

getDeclarationByName(name: string): AnyShape

Inherited from WebApiBaseUnit.getDeclarationByName
- Defined in webapi-parser.d.ts:12
Gets declaration by name.

Parameters
- name: string
  
  String name of declaration to look for.
Returns AnyShape

Found declaration as NodeShape.

objectPropertyTerms

objectPropertyTerms(): ObjectPropertyTerm[]

- Defined in webapi-parser.d.ts:116
Returns ObjectPropertyTerm[]

references

references(): BaseUnit[]

Inherited from BaseUnit.references
- Defined in amf-client-js.d.ts:480
Returns BaseUnit[]

withBase

withBase(base: string): WebApiVocabulary

- Defined in webapi-parser.d.ts:110
Parameters
- base: string
Returns WebApiVocabulary

withExternals

withExternals(externals: External[]): WebApiVocabulary

- Defined in webapi-parser.d.ts:112
Parameters
- externals: External[]
Returns WebApiVocabulary

withImports

withImports(vocabularies: VocabularyReference[]): WebApiVocabulary

- Defined in webapi-parser.d.ts:114
Parameters
- vocabularies: VocabularyReference[]
Returns WebApiVocabulary

withLocation

withLocation(location: string): this

Inherited from BaseUnit.withLocation
- Defined in amf-client-js.d.ts:492
Parameters
- location: string
Returns this

withName

withName(name: string): WebApiVocabulary

- Defined in webapi-parser.d.ts:108
Parameters
- name: string
Returns WebApiVocabulary

withRaw

withRaw(raw: string): this

Inherited from BaseUnit.withRaw
- Defined in amf-client-js.d.ts:490
Parameters
- raw: string
Returns this

withReferences

withReferences(references: BaseUnit[]): this

Inherited from BaseUnit.withReferences
- Defined in amf-client-js.d.ts:488
Parameters
- references: BaseUnit[]
Returns this

withUsage

withUsage(usage: string): this

Inherited from BaseUnit.withUsage
- Defined in amf-client-js.d.ts:494
Parameters
- usage: string
Returns this

Generated using TypeDoc