• Log a compatibility warning which is filtered based on the client's defined compatibility settings.

    Parameters

    • message: string

      The original warning or error message

    • Optionaloptions: {
          details?: string;
          mode?: number;
          once?: boolean;
          since?: string | number;
          stack?: boolean;
          until?: string | number;
      } = {}

      Additional options which customize logging

      • Optionaldetails?: string

        Additional details to append to the logged message

      • Optionalmode?: number

        A logging level in COMPATIBILITY_MODES which overrides the configured default

      • Optionalonce?: boolean

        Log this the message only once?

      • Optionalsince?: string | number

        A version identifier since which a change was made

      • Optionalstack?: boolean

        Include the message stack trace

      • Optionaluntil?: string | number

        A version identifier until which a change remains supported

    Returns void

    An Error if the mode is ERROR