WebApiDocument | webapi-parser

Subclass of Document inheriting WebApiBaseUnit utility methods.

Hierarchy

WebApiBaseUnitWithDeclaresModelAndEncodesModel
- WebApiDocument

Implements

Index

Properties

Methods

Properties

declares

declares: DomainElement[]

encodes

encodes: DomainElement

id

id: string

location

location: string

raw

raw: string | undefined

usage

usage: StrField

Methods

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.

references

references(): BaseUnit[]

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

withDeclaredElement

withDeclaredElement(declared: DomainElement): this

Inherited from WebApiBaseUnitWithDeclaresModelAndEncodesModel.withDeclaredElement
- Defined in webapi-parser.d.ts:35
Parameters
- declared: DomainElement
Returns this

withDeclares

withDeclares(declares: DomainElement[]): this

Inherited from WebApiBaseUnitWithDeclaresModelAndEncodesModel.withDeclares
- Defined in webapi-parser.d.ts:37
Parameters
- declares: DomainElement[]
Returns this

withEncodes

withEncodes(enocdes: DomainElement): this

Inherited from WebApiBaseUnitWithDeclaresModelAndEncodesModel.withEncodes
- Defined in webapi-parser.d.ts:42
Parameters
- enocdes: DomainElement
Returns this

withLocation

withLocation(location: string): this

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

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