@league-of-foundry-developers/foundry-vtt-types/src/foundry/common/utils/logging.d.mts

TypeScript type definitions for Foundry VTT

import type { COMPATIBILITY_MODES } from "../constants.d.mts";

/**
 * Log a compatibility warning which is filtered based on the client's defined compatibility settings.
 * @param message - The original warning or error message
 * @param options - Additional options which customize logging (default: `{}`)
 * @throws        - An Error if the mode is ERROR
 */
export declare function logCompatibilityWarning(message: string, options?: LogCompatibilityWarningOptions): void;
export interface LogCompatibilityWarningOptions {
  /**
   * A logging level in COMPATIBILITY_MODES which overrides the configured default
   */
  mode?: COMPATIBILITY_MODES;

  /**
   * A version identifier since which a change was made
   */
  since?: number | string;

  /**
   * A version identifier until which a change remains supported
   */
  until?: number | string;

  /**
   * Additional details to append to the logged message
   */
  details?: string;

  /**
   * Include the message stack trace
   * @defaultValue `true`
   */
  stack?: boolean;

  /**
   * Log this message only once?
   * @defaultValue `false`
   */
  once?: boolean;
}