abstractAModule <S, T>

@group

Modules

Implements

• IModule<S, T>

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Constructors

constructor

• AModule<S, T>(moduleId: string): AModule<S, T>

• Type parameters

  • S
  • T: UnknownModel

  Parameters

  • moduleId: string

  Returns AModule<S, T>

Properties

readonlymoduleId

moduleId: string

staticreadonlyMODULE_PACKAGE

MODULE_PACKAGE: string

staticreadonlyMODULE_SCHEMA

MODULE_SCHEMA: any

Methods

abstractonInit

• onInit(inputs: S): Promise<T | UnknownModel[]>

• Implementation of IModule.onInit

  Parameters

  • inputs: S

  Returns Promise<T | UnknownModel[]>

registerHooks

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

• Implementation of IModule.registerHooks

  Returns { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

  • optionalpostCommitHooks?: PostHookSignature[]

  • optionalpostModelActionHooks?: PostHookSignature[]

  • optionalpostResourceActionHooks?: PostHookSignature[]

  • optionalpreCommitHooks?: PreHookSignature[]

  • optionalpreModelActionHooks?: PreHookSignature[]

  • optionalpreResourceActionHooks?: PreHookSignature[]

registerMetadata

• registerMetadata(inputs: S): Promise<Record<string, unknown>>

• Implementation of IModule.registerMetadata

  Parameters

  • inputs: S

  Returns Promise<Record<string, unknown>>