NamedEntityInfo interface

Package:

@azure/dtdl-parser

Extends

EntityInfo

Properties

entityKind
name

Inherited Properties

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

Inherited Methods

validateInstance(string)

Property Details

entityKind

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

Property Value

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

name

name?: string

Property Value

string

Inherited Property Details

childOf

childOf: undefined | string

Property Value

undefined | string

Inherited From EntityInfo.childOf

comment

comment?: string

Property Value

string

Inherited From EntityInfo.comment

definedIn

definedIn: undefined | string

Property Value

undefined | string

Inherited From EntityInfo.definedIn

description

description?: LanguageStringType

Property Value

LanguageStringType

Inherited From EntityInfo.description

displayName

displayName?: LanguageStringType

Property Value

LanguageStringType

Inherited From EntityInfo.displayName

dtdlVersion

dtdlVersion: number

Property Value

number

Inherited From EntityInfo.dtdlVersion

id

id: string

Property Value

string

Inherited From EntityInfo.id

languageVersion

languageVersion?: number

Property Value

number

Inherited From EntityInfo.languageVersion

supplementalProperties

supplementalProperties: {[x: string]: any}

Property Value

{[x: string]: any}

Inherited From EntityInfo.supplementalProperties

supplementalTypeIds

supplementalTypeIds: string[]

Property Value

string[]

Inherited From EntityInfo.supplementalTypeIds

supplementalTypes

supplementalTypes: SupplementalTypeInfo[]

Property Value

SupplementalTypeInfo[]

Inherited From EntityInfo.supplementalTypes

undefinedProperties

undefinedProperties: {[name: string]: any}

Property Value

{[name: string]: any}

Inherited From EntityInfo.undefinedProperties

undefinedTypes

undefinedTypes: string[]

Property Value

string[]

Inherited From EntityInfo.undefinedTypes

Inherited Method Details

validateInstance(string)

function validateInstance(instanceText: string): boolean

Parameters

instanceText

string

Returns

boolean

Inherited From EntityInfo.validateInstance