kernel/modules/manifest

Classes

ModuleError

Defined in: app/src/kernel/modules/manifest.ts:74

Thrown for invalid manifests and inconsistent module graphs.

Extends

• Error

Constructors

Constructor

new ModuleError(message?): ModuleError

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1080

Parameters

message?

string

Returns

ModuleError

Inherited from

Error.constructor

Constructor

new ModuleError(message?, options?): ModuleError

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1080

Parameters

message?

string

options?

ErrorOptions

Returns

ModuleError

Inherited from

Error.constructor

Properties

name

readonly name: "ModuleError" = 'ModuleError'

Defined in: app/src/kernel/modules/manifest.ts:75

Overrides

Error.name

Interfaces

FeatureModule

Defined in: app/src/kernel/modules/manifest.ts:37

The code of a feature module that runs in the browser process.

Methods

activate()

activate(context): void | Promise<void>

Defined in: app/src/kernel/modules/manifest.ts:42

Starts the module: registers its contributions in context.subscriptions.

Parameters

context

ModuleContext

The module’s context.

Returns

void | Promise<void>

deactivate()?

optional deactivate(): void | Promise<void>

Defined in: app/src/kernel/modules/manifest.ts:44

Stops work that subscriptions cannot undo by themselves. Optional.

Returns

void | Promise<void>

dispose()?

optional dispose(): void

Defined in: app/src/kernel/modules/manifest.ts:46

Releases resources the module holds outside its subscriptions. Optional.

Returns

void

---

ModuleActivation

Defined in: app/src/kernel/modules/manifest.ts:9

Decides whether an optional module is active.

Properties

default

readonly default: boolean

Defined in: app/src/kernel/modules/manifest.ts:15

Whether the module is active when neither policy nor setting decide.

policy?

readonly optional policy?: string

Defined in: app/src/kernel/modules/manifest.ts:13

Policy name that administrators use to force the module on or off.

setting?

readonly optional setting?: string

Defined in: app/src/kernel/modules/manifest.ts:11

Setting key that switches the module on or off, such as workspaces.enabled.

---

ModuleContext

Defined in: app/src/kernel/modules/manifest.ts:19

Everything a module receives when it is activated.

Properties

id

readonly id: string

Defined in: app/src/kernel/modules/manifest.ts:21

The module’s own identifier.

logger

readonly logger: Logger

Defined in: app/src/kernel/modules/manifest.ts:33

A logger scoped to module.<id>.

services

readonly services: Container

Defined in: app/src/kernel/modules/manifest.ts:26

The module’s child container. Services registered here are private to the module and disposed when it is deactivated.

subscriptions

readonly subscriptions: DisposableStore

Defined in: app/src/kernel/modules/manifest.ts:31

Registrations to undo on deactivation: commands, IPC handlers, listeners and UI slots all go here.

---

ModuleManifest

Defined in: app/src/kernel/modules/manifest.ts:56

Static description of a feature module. Manifests are tiny and always bundled; the code behind main is a separate chunk that is only imported when the module is active.

Properties

activation?

readonly optional activation?: ModuleActivation

Defined in: app/src/kernel/modules/manifest.ts:66

How an optional module is switched on and off. Required unless core is set.

core?

readonly optional core?: boolean

Defined in: app/src/kernel/modules/manifest.ts:62

Core modules are always active and cannot be switched off. They may only depend on other core modules.

dependsOn?

readonly optional dependsOn?: readonly string[]

Defined in: app/src/kernel/modules/manifest.ts:64

Modules that must be active before this one.

id

readonly id: string

Defined in: app/src/kernel/modules/manifest.ts:57

main?

readonly optional main?: () => Promise<{ default: FeatureModuleClass; }>

Defined in: app/src/kernel/modules/manifest.ts:70

Imports the module’s browser-process code.

Returns

Promise<{ default: FeatureModuleClass; }>

restartRequired?

readonly optional restartRequired?: boolean

Defined in: app/src/kernel/modules/manifest.ts:68

Whether switching the module on or off only takes effect after a restart.

Type Aliases

FeatureModuleClass

FeatureModuleClass = InjectableClass<FeatureModule>

Defined in: app/src/kernel/modules/manifest.ts:50

A feature module class, constructed by the module’s container.

---

ModuleId

ModuleId = string

Defined in: app/src/kernel/modules/manifest.ts:6

Identifier of a feature module, in kebab-case, such as tab-groups.

Functions

defineModule()

defineModule<M>(manifest): Readonly<M>

Defined in: app/src/kernel/modules/manifest.ts:86

Declares a feature module and checks its manifest.

Type Parameters

M

M extends ModuleManifest

Parameters

manifest

M

The module’s static description.

Returns

Readonly<M>

The frozen manifest.

Throws

ModuleError for an invalid id or a missing activation on an optional module.