@quadnix/octo

Index

Decorators

• Action
• Anchor
• Factory
• Model
• Module
• OnEvent
• Overlay
• Resource
• Validate

Errors/Container

• ContainerError
• ContainerRegistrationError
• ContainerResolutionError

Errors/Input

• InputError
• InputRegistrationError
• InputResolutionError

Errors/Module

• ModuleError

Errors/Node

• ContextNodeError
• DependencyError
• DiffInverseResourceError
• ModelError
• NodeError
• NodeUnsynthError
• OverlayError
• RemoveResourceError
• ResourceError

Errors/Schema

• SchemaError

Errors/Transaction

• DiffsOnDirtyResourcesTransactionError
• InputNotFoundTransactionError
• NoMatchingActionFoundTransactionError
• ResourceActionExceptionTransactionError
• ResourceActionTimeoutTransactionError
• TransactionError
• ValidationTransactionError

Events

• Event

Events/Action

• ActionEvent

Events/Hooks

• HookEvent

Events/Hooks/Commit

• CommitHookEvent
• PostCommitHookCallbackDoneEvent
• PreCommitHookCallbackDoneEvent

Events/Hooks/Model

• ModelActionHookEvent
• PostModelActionHookCallbackDoneEvent
• PreModelActionHookCallbackDoneEvent

Events/Hooks/Resource

• PostResourceActionHookCallbackDoneEvent
• PreResourceActionHookCallbackDoneEvent
• ResourceActionHookEvent

Events/Module

• ModuleEvent

Events/Registration

• AnchorRegistrationEvent
• ModelActionRegistrationEvent
• ModelRegistrationEvent
• OverlayRegistrationEvent
• RegistrationEvent
• ResourceActionRegistrationEvent
• ResourceRegistrationEvent

Events/Serialization

• ActualResourceSerializedEvent
• ModelDeserializedEvent
• ModelSerializedEvent
• NewResourceSerializedEvent
• ResourceDeserializedEvent
• SerializationEvent

Events/Transaction

• ModelActionTransactionEvent
• ModelDiffsTransactionEvent
• ModelTransactionTransactionEvent
• ResourceActionCompletedTransactionEvent
• ResourceActionInitiatedTransactionEvent
• ResourceActionSummaryTransactionEvent
• ResourceDiffsTransactionEvent
• ResourceTransactionTransactionEvent
• TransactionEvent

Functions/Container

• Container
• TestContainer

Functions/Dependency

• DependencyRelationship
• Dependency
• IDependency

Functions/Diff

• DiffAction
• Diff
• DiffUtility
• DiffMetadata

Functions/Node

• ANodeAction

Functions/Schema

• Schema

Main

• Octo

Models

• AModel
• IModelAction
• IModelReference

Models/Account

• AccountType
• Account
• AccountSchema

Models/App

• App
• AppSchema

Models/Deployment

• Deployment
• DeploymentSchema

Models/Environment

• Environment
• EnvironmentSchema

Models/Execution

• Execution
• ExecutionSchema

Models/Filesystem

• Filesystem
• FilesystemSchema

Models/Image

• Image
• ImageSchema

Models/Pipeline

• Pipeline
• PipelineSchema

Models/Region

• Region
• RegionSchema

Models/Server

• Server
• ServerSchema

Models/Service

• Service
• ServiceSchema

Models/Subnet

• SubnetType
• Subnet
• SubnetSchema

Modules

• AModule
• TestModuleContainer
• TestModule

Overlays

• AAnchor
• AOverlay
• BaseAnchorSchema
• BaseOverlaySchema

Resources

• AResource
• BaseResourceSchema
• IResourceAction

Services/State Management

• LocalStateProvider
• StateManagementService
• TestStateProvider
• IStateProvider

Types

• MatchingAnchor
• MatchingModel
• MatchingResource
• ActionOutputs
• AnchorSchema
• Constructable
• DiffValueTypePropertyUpdate
• DiffValueTypeTagUpdate
• EnhancedModuleSchema
• ModelSerializedOutput
• ModuleSchema
• ModuleSchemaInputs
• OverlaySchema
• ResourceSchema
• ResourceSerializedOutput
• hasNodeName
• stub

Modules

TestModule

TestModule<M>:

@group

Modules

---

Type parameters

• M: UnknownModule

optionalhidden

hidden?: boolean

inputs

inputs: ModuleSchemaInputs<M>

moduleId

moduleId: string

type

type: Constructable<M>

Types

ActionOutputs

ActionOutputs: {}

@group

Types

---

Type declaration

• [key string]: UnknownResource

AnchorSchema

AnchorSchema<T>: T extends AAnchor<infer S, any> ? S : never

@group

Types

---

Type parameters

• T

Constructable

Constructable<T>: new (...args: any[]) => T

@group

Types

---

Type parameters

• T

Type declaration

• • new (...args: any[]): T

  • Parameters

    • rest...args: any[]

    Returns T

DiffValueTypePropertyUpdate

DiffValueTypePropertyUpdate:

@group

Types

key

key: string

value

value: unknown

DiffValueTypeTagUpdate

DiffValueTypeTagUpdate:

@group

Types

add

add: {}

Type declaration

• [key string]: string

delete

delete: string[]

update

update: {}

Type declaration

• [key string]: string

EnhancedModuleSchema

EnhancedModuleSchema<T>:

@group

Types

---

Type parameters

• T: UnknownModule

inputs

inputs: { [ K in keyof ModuleSchemaInputs<T> ]: ModuleSchema<T>[K] }

metadata

metadata: Awaited<ReturnType<T[registerMetadata]>>

models

models: Record<string, UnknownModel>

overlays

overlays: Record<string, UnknownOverlay>

resources

resources: Record<string, UnknownResource>

ModelSerializedOutput

ModelSerializedOutput:

@group

Types

anchors

anchors: (AnchorSchema<UnknownAnchor> & { className: string; location: IModelReference & { type: NodeType } })[]

dependencies

dependencies: IDependency[]

models

models: {}

Type declaration

• [p string]: { className: string; model: IUnknownModel }

overlays

overlays: { className: string; overlay: OverlaySchema<UnknownOverlay> }[]

ModuleSchema

ModuleSchema<T>: T extends AModule<infer S, any> ? S : never

@group

Types

---

Type parameters

• T

ModuleSchemaInputs

ModuleSchemaInputs<T>: { [ K in ClassRequiredProperties<ModuleSchema<T>> ]: ModuleSchema<T>[K] } & { [ K in ClassOptionalProperties<ModuleSchema<T>> ]?: ModuleSchema<T>[K] }

@group

Types

---

Type parameters

• T

OverlaySchema

OverlaySchema<T>: T extends AOverlay<infer S, any> ? S : never

@group

Types

---

Type parameters

• T

ResourceSchema

ResourceSchema<T>: T extends AResource<infer S, any> ? S : never

@group

Types

---

Type parameters

• T

ResourceSerializedOutput

ResourceSerializedOutput:

@group

Types

dependencies

dependencies: IDependency[]

resources

resources: {}

Type declaration

• [p string]: { className: string; resource: BaseResourceSchema }