Octo

Index

Constructors

• constructor

Methods

• beginTransaction
• compose
• getAllResources
• getModuleOutput
• initialize
• loadModules
• registerCapture
• registerInputs

Constructors

constructor

• new Octo(): Octo

• Returns Octo

Methods

beginTransaction

• beginTransaction(app: App, __namedParameters?: TransactionOptions): AsyncGenerator<DiffMetadata[][], DiffMetadata[][], unknown>

• Parameters

  • app: App

  • __namedParameters: TransactionOptions = {}

  Returns AsyncGenerator<DiffMetadata[][], DiffMetadata[][], unknown>

compose

• compose(): Promise<void>

• Returns Promise<void>

getAllResources

• getAllResources(): UnknownResource[]

• Returns UnknownResource[]

getModuleOutput

• getModuleOutput<T>(module: string | Constructable<IModule<T>>): undefined | T

• Type parameters

  • T

  Parameters

  • module: string | Constructable<IModule<T>>

  Returns undefined | T

initialize

• initialize(stateProvider: IStateProvider, initializeInContainer?: { options?: { args?: unknown[]; metadata?: {} }; type: string | Constructable<unknown> }[], excludeInContainer?: { type: string | Constructable<unknown> }[]): Promise<void>

• Parameters

  • stateProvider: IStateProvider

  • initializeInContainer: { options?: { args?: unknown[]; metadata?: {} }; type: string | Constructable<unknown> }[] = []

  • excludeInContainer: { type: string | Constructable<unknown> }[] = []

  Returns Promise<void>

loadModules

• loadModules(modules: Constructable<IModule<any>>[]): void

• Parameters

  • modules: Constructable<IModule<any>>[]

  Returns void

registerCapture

• registerCapture<T>(resourceId: T[resourceId], response: Partial<T[response]>): void

• Type parameters

  • T: AResource<T>

  Parameters

  • resourceId: T[resourceId]

  • response: Partial<T[response]>

  Returns void

registerInputs

• registerInputs(inputs: ActionInputs): void

• Parameters

  • inputs: ActionInputs

  Returns void