Interface ResourceType

Information about a resource type, as defined in the archon.yaml file.

interface ResourceType {
    description?: string;
    intents?: ResourceIntent[];
    name: ResourceTypeName;
    parentName?: string;
    singleton?: ArchonResourceId;
}

Properties

description? intents? name parentName? singleton?

Properties

Optionaldescription

description?: string

A human-readable description of the resource type, defined in the archon.yaml file.

Optionalintents

intents?: ResourceIntent[]

The intents that can be used to access resources of this type, if any are defined in the archon.yaml file.

name

name: ResourceTypeName

The name of the resource type, defined in the archon.yaml file.

OptionalparentName

parentName?: string

Parent resource type, if any. If this resource type has no parent, this field will be omitted.

Optionalsingleton

singleton?: ArchonResourceId

If this resource type is a singleton, this field is the ARID of the singleton resource. If this resource type is not a singleton, this field will be omitted.

Settings

Member Visibility

On This Page

Properties