Module

API Reference / modelence / server / Module

Defined in: src/app/module.ts:44

The Module class is a core building block of a Modelence application that encapsulates related functionality. Modules can contain stores, queries, mutations, routes, cron jobs and configurations.

Example

const todoModule = new Module('todo', {
  stores: [dbTodos],
  queries: {
    async getAll() {
      // Fetch and return all Todo items
    }
  },
  mutations: {
    async create({ title }, { user }) {
      // Create a new Todo item
    }
  }
});

Constructors

Constructor

new Module(name, options): Module

Defined in: src/app/module.ts:81

Creates a new Module instance

Parameters

Parameter	Type	Description
name	string	The unique name of the module. This name is used to namespace queries, mutations, cron jobs and configuration values with a prefix (e.g. “todo.create”)
options	{ channels?: ServerChannel<unknown>[]; configSchema?: ConfigSchema; cronJobs?: Record<string, CronJobInputParams>; mutations?: Mutations; queries?: Queries; rateLimits?: RateLimitRule[]; routes?: RouteDefinition[]; stores?: Store<any, any>[]; }	Module configuration options
options.channels?	ServerChannel<unknown>[]	-
options.configSchema?	ConfigSchema	-
options.cronJobs?	Record<string, CronJobInputParams>	-
options.mutations?	Mutations	-
options.queries?	Queries	-
options.rateLimits?	RateLimitRule[]	-
options.routes?	RouteDefinition[]	-
options.stores?	Store<any, any>[]	-

Returns

Module