Interface IDependencyInformationEntity

An entity inside a IDependencyInformation object.

interface IDependencyInformationEntity {
    attributes?: Nilable<DependencyInformationEntityAttributes>;
    category?: Nilable<string>;
    entities?: Nilable<DependencyInformationEntities>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    key: ReferenceValue;
    references?: Nilable<string[]>;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Hierarchy

Properties

attributes? category? entities? hasLocalEffects? hasRemoteEffects? key references? remarks? type?

Properties

Optional attributes

attributes?: Nilable<DependencyInformationEntityAttributes>

Optional list of attributes.

Optional category

category?: Nilable<string>

An optional value that categories this entity. Value should be handled as slug value, case-insensitive.

Optional entities

entities?: Nilable<DependencyInformationEntities>

Optional children for this entity.

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on app's side, it will have effects in this application in general.

Default

false

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, it will have effects on app's side in general.

Default

true

key

key: ReferenceValue

The unique key. Value should be handled case-insensitive.

Optional references

references?: Nilable<string[]>

An optional list of references. Should be handled as URIs.

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks. Should be handled as Markdown, if possible.

Optional type

type?: Nilable<string>

An optional value for classification. Value should be handled as slug value, case-insensitive.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc