Octo

@group

Main

Index

Constructors

• constructor

Methods

• beginTransaction
• compose
• getModule
• getModuleResources
• initialize
• loadModule
• orderModules
• registerCapture
• registerHooks
• registerSchemaTranslation
• registerTags

Constructors

constructor

• Octo(): Octo

• Returns Octo

Methods

beginTransaction

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

• Parameters

  • app: App

  • __namedParameters: TransactionOptions = {}

  Returns AsyncGenerator<DiffMetadata[][]>

compose

• compose(): Promise<{}>

• Returns Promise<{}>

getModule

• getModule<M>(...args: [moduleId: string]): undefined | M

• Type parameters

  • M: UnknownModule

  Parameters

  • rest...args: [moduleId: string]

  Returns undefined | M

getModuleResources

• getModuleResources(...args: [moduleId: string]): UnknownResource[]

• Parameters

  • rest...args: [moduleId: string]

  Returns UnknownResource[]

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>

loadModule

• loadModule<M>(module: string | Constructable<M>, moduleId: string, inputs: ModuleSchemaInputs<M>): void

• Type parameters

  • M: UnknownModule

  Parameters

  • module: string | Constructable<M>

  • moduleId: string

  • inputs: ModuleSchemaInputs<M>

  Returns void

orderModules

• orderModules(...args: [modules: (string | Constructable<UnknownModule>)[]]): void

• Parameters

  • rest...args: [modules: (string | Constructable<UnknownModule>)[]]

  Returns void

registerCapture

• registerCapture<S>(resourceContext: string, response: Partial<S[response]>): void

• Type parameters

  • S: BaseResourceSchema

  Parameters

  • resourceContext: string

  • response: Partial<S[response]>

  Returns void

registerHooks

• registerHooks(...args: [{ postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }?]): void

• Parameters

  • rest...args: [{ postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }?]

  Returns void

registerSchemaTranslation

• registerSchemaTranslation(...args: [from: Constructable<unknown>, to: Constructable<unknown>, translator: (synth: unknown) => unknown]): void

• Parameters

  • rest...args: [from: Constructable<unknown>, to: Constructable<unknown>, translator: (synth: unknown) => unknown]

  Returns void

registerTags

• registerTags(args: { scope: { moduleId?: string; resourceContext?: string }; tags: {} }[]): void

• Parameters

  • args: { scope: { moduleId?: string; resourceContext?: string }; tags: {} }[]

  Returns void