Function defineModule

defineModule<K extends keyof ServiceCollection, THost>(
    config: {
        create: (host: THost) => NonNullable<ServiceCollection[K]>;
        dependsOn?: DockviewModule<any>[];
        init?: (
            host: THost,
            service: NonNullable<ServiceCollection[K]>,
        ) => DockviewIDisposable;
        name: string;
        options?: string[];
        serviceKey: K;
    },
): DockviewModule<THost>
Typed helper for defining a module. Enforces that the factory's return type matches the slot in ServiceCollection at compile time, replacing the manual cast each module file would otherwise need.
Type Parameters
- K extends keyof ServiceCollection
- THost
Parameters
- config: {
      create: (host: THost) => NonNullable<ServiceCollection[K]>;
      dependsOn?: DockviewModule<any>[];
      init?: (
          host: THost,
          service: NonNullable<ServiceCollection[K]>,
      ) => DockviewIDisposable;
      name: string;
      options?: string[];
      serviceKey: K;
  }
  - create: (host: THost) => NonNullable<ServiceCollection[K]>
  - OptionaldependsOn?: DockviewModule<any>[]
  - Optionalinit?: (host: THost, service: NonNullable<ServiceCollection[K]>) => DockviewIDisposable
  - name: string
  - Optionaloptions?: string[]
    See DockviewModule.options.
  - serviceKey: K
Returns DockviewModule<THost>
- Defined in dockview/modules.ts:96