EntityInfo interface

Package:

@azure/dtdl-parser

Properties

childOf
comment
definedIn
description
displayName
dtdlVersion
entityKind
id
languageVersion
supplementalProperties
supplementalTypeIds
supplementalTypes
undefinedProperties
undefinedTypes

Methods

validateInstance(string)

Property Details

childOf

childOf: undefined | string

Property Value

undefined | string

comment

comment?: string

Property Value

string

definedIn

definedIn: undefined | string

Property Value

undefined | string

description

description?: LanguageStringType

Property Value

LanguageStringType

displayName

displayName?: LanguageStringType

Property Value

LanguageStringType

dtdlVersion

dtdlVersion: number

Property Value

number

entityKind

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

Property Value

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

id

id: string

Property Value

string

languageVersion

languageVersion?: number

Property Value

number

supplementalProperties

supplementalProperties: {[x: string]: any}

Property Value

{[x: string]: any}

supplementalTypeIds

supplementalTypeIds: string[]

Property Value

string[]

supplementalTypes

supplementalTypes: SupplementalTypeInfo[]

Property Value

SupplementalTypeInfo[]

undefinedProperties

undefinedProperties: {[name: string]: any}

Property Value

{[name: string]: any}

undefinedTypes

undefinedTypes: string[]

Property Value

string[]

Method Details

validateInstance(string)

function validateInstance(instanceText: string): boolean

Parameters

instanceText

string

Returns

boolean