Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/dtdl-parser

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ArrayKinds

ArrayKinds: "array"

BooleanKinds

BooleanKinds: "boolean"

CommandKinds

CommandKinds: "command"

CommandPayloadKinds

CommandPayloadKinds: "commandpayload" | "commandrequest" | "commandresponse"

CommandRequestKinds

CommandRequestKinds: "commandrequest"

CommandResponseKinds

CommandResponseKinds: "commandresponse"

CommandTypeKinds

CommandTypeKinds: "commandtype"

ComplexSchemaKinds

ComplexSchemaKinds: "array" | "enum" | "map" | "object"

ComponentKinds

ComponentKinds: "component"

ContentKinds

ContentKinds: "command" | "component" | "property" | "relationship" | "telemetry"

DateKinds

DateKinds: "date"

DateTimeKinds

DateTimeKinds: "datetime"

DoubleKinds

DoubleKinds: "double"

DurationKinds

DurationKinds: "duration"

EntityKinds

EntityKinds: "array" | "boolean" | "command" | "commandpayload" | "commandtype" | "component" | "date" | "datetime" | "double" | "duration" | "enum" | "enumvalue" | "field" | "float" | "integer" | "interface" | "long" | "map" | "mapkey" | "mapvalue" | "object" | "property" | "relationship" | "string" | "telemetry" | "time" | "unit" | "unitattribute" | "commandrequest" | "commandresponse" | "latenttype" | "namedlatenttype" | "reference"

EnumKinds

EnumKinds: "enum"

EnumValueKinds

EnumValueKinds: "enumvalue"

ExpansionType

ExpansionType: keyof typeof Expansion

FetchDependencies

FetchDependencies: (dtmis: string | string[], options?: GetModelsOptions) => Promise<{} | null>

Type declaration

    • (dtmis: string | string[], options?: GetModelsOptions): Promise<{} | null>
    • Parameters

      • dtmis: string | string[]
      • Optional options: GetModelsOptions

      Returns Promise<{} | null>

FieldKinds

FieldKinds: "field"

FloatKinds

FloatKinds: "float"

IntegerKinds

IntegerKinds: "integer"

InterfaceKinds

InterfaceKinds: "interface"

LanguageStringType

LanguageStringType: {}

Type declaration

  • [languageCode: string]: string

LatentTypeKinds

LatentTypeKinds: "latenttype"

LongKinds

LongKinds: "long"

MapKeyKinds

MapKeyKinds: "mapkey"

MapKinds

MapKinds: "map"

MapValueKinds

MapValueKinds: "mapvalue"

ModelDict

ModelDict: {}

Type declaration

NamedEntityKinds

NamedEntityKinds: "command" | "commandpayload" | "component" | "enumvalue" | "field" | "mapkey" | "mapvalue" | "property" | "relationship" | "telemetry" | "unitattribute" | "commandrequest" | "commandresponse" | "namedlatenttype"

NamedLatentTypeKinds

NamedLatentTypeKinds: "namedlatenttype"

NumericSchemaKinds

NumericSchemaKinds: "double" | "float" | "integer" | "long"

ObjectKinds

ObjectKinds: "object"

PrefixDict

PrefixDict: {}

Type declaration

  • [prefix: string]: string

PrimitiveSchemaKinds

PrimitiveSchemaKinds: "boolean" | "date" | "datetime" | "double" | "duration" | "float" | "integer" | "long" | "string" | "time"

PropertyKinds

PropertyKinds: "property"

Reference

Reference<T>: { ref: T | undefined }

Type parameters

  • T

Type declaration

  • ref: T | undefined

ReferenceKinds

ReferenceKinds: "reference"

RelationshipKinds

RelationshipKinds: "relationship"

ReverseTermDict

ReverseTermDict: {}

Type declaration

  • [dtmiValue: string]: string

SchemaFieldKinds

SchemaFieldKinds: "commandpayload" | "field" | "mapvalue" | "commandrequest" | "commandresponse"

SchemaKinds

SchemaKinds: "array" | "boolean" | "date" | "datetime" | "double" | "duration" | "enum" | "float" | "integer" | "long" | "map" | "object" | "string" | "time"

StringKinds

StringKinds: "string"

TelemetryKinds

TelemetryKinds: "telemetry"

TemporalSchemaKinds

TemporalSchemaKinds: "date" | "datetime" | "duration" | "time"

TermDict

TermDict: {}

Type declaration

TimeKinds

TimeKinds: "time"

UnitAttributeKinds

UnitAttributeKinds: "unitattribute"

UnitKinds

UnitKinds: "unit"

Variables

Const DTMIPREFIX

DTMIPREFIX: "dtmi:" = "dtmi:"

Const DTMI_REGEX

DTMI_REGEX: any = new RegExp("^dtmi:(?:_+[A-Za-z0-9]|[A-Za-z])(?:[A-Za-z0-9_]*[A-Za-z0-9])?(?::(?:_+[A-Za-z0-9]|[A-Za-z])(?:[A-Za-z0-9_]*[A-Za-z0-9])?)*(?:;[1-9][0-9]{0,8}(?:\\.[1-9][0-9]{0,5})?)?(?:#(?:(?:_+[A-Za-z0-9]|[A-Za-z])(?:[A-Za-z0-9_]*[A-Za-z0-9])?)?)?$")

Const SEPARATORS

SEPARATORS: any = new RegExp(":|;")

Const TYPE_KEYWORD

TYPE_KEYWORD: "@type" = "@type"

Const url

url: { constructor: any; prototype: __type; createObjectURL: any; revokeObjectURL: any } = URL

Type declaration

  • constructor: function
    • Parameters

      • url: string
      • Optional base: string | __type

      Returns __type

  • prototype: __type
  • createObjectURL: function
    • createObjectURL(object: any): string
    • Parameters

      • object: any

      Returns string

  • revokeObjectURL: function
    • revokeObjectURL(url: string): void
    • Parameters

      • url: string

      Returns void

Functions

createParser

createParsingError

Const getFilenames

  • getFilenames(_testCaseFolder: string): string[]
  • getFilenames(testCaseFolder: string): string[]

getTestcase

  • getTestcase(filename: string): string

Const referenceInit

  • referenceInit(): { ref: undefined }

Generated using TypeDoc