Skip to content

Config

Modules can individually provide their own Config configuration

Define Config

Taking the module a-demo as an example, define the Config configuration of the module:

src/suite/a-demo/modules/a-demo/src/config/config.ts

typescript
export const config: ZovaConfigOptional = (_app: ZovaApplication) => {
  return {
    prompt: 'Hello World',
  };
};
  • Just define the required configuration fields directly, and the system will automatically extract the type information of config

Use Config

The Config configuration of the module can be obtained through the Scope instance

typescript
export class TestA {
  protected async __init__() {
    const message = this.scope.config.prompt;
    console.log(message);
  }
}
  • Gif Demonstration scope-config

Use Config cross-module

typescript
import type { ScopeModuleADemo } from 'zova-module-a-demo';

export class TestA {
  @UseScope('a-demo')
  scopeModuleADemo: ScopeModuleADemo;

  protected async __init__() {
    const message = this.scopeModuleADemo.config.prompt;
    console.log(message);
  }
}

Override Config

You can use project-level Config to override module-level Config

src/front/config/config/config.ts

typescript
export default function (_meta: ZovaConfigMeta) {
  const config = {};

  // module config
  config.modules = {
    'a-demo': {
      prompt: 'Hello World!!!',
    },
  };

  return config;
}
  • Change the prompt of the module a-demo to Hello World!!!

Released under the MIT License.