MagicMirror/module-types.ts

type ModuleProperties = {
  defaults?: object;
  [key: string]: any;
  start?(): void;
  getScripts?(): string[];
  getStyles?(): string[];
  getTranslations?(): object;
  getDom?(): HTMLElement;
  getHeader?(): string;
  getTemplate?(): string;
  getTemplateData?(): object;
  notificationReceived?(notification: string, payload: any, sender: object): void;
  nunjucksEnvironment?(): void;
  socketNotificationReceived?(notification: string, payload: any): void;
  suspend?(): void;
  resume?(): void;
};

export declare const Module: {
  register(moduleName: string, moduleProperties: ModuleProperties): void;
};

export declare const Log: {
  info(message?: any, ...optionalParams: any[]): void;
  log(message?: any, ...optionalParams: any[]): void;
  error(message?: any, ...optionalParams: any[]): void;
  warn(message?: any, ...optionalParams: any[]): void;
  group(groupTitle?: string, ...optionalParams: any[]): void;
  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void;
  groupEnd(): void;
  time(timerName?: string): void;
  timeEnd(timerName?: string): void;
  timeStamp(timerName?: string): void;
};