Function deprecate

  • deprecate(name, description): void

  • Logs a deprecation warning. Deprecation logs can be configured via log-deprecations flag.

    Parameters

    • name: string

      Class or function that will be deprecated

    • description: string

      A short description which class or function shall be used instead

    Returns void

    Example

    import deprecate from "apprt-core/deprecate";

    deprecate("ct/_string encodeHTML", "Use apprt-core/string-escape instead.");
    // => logs console warning:
    // [Deprecation] ct/_string encodeHTML is deprecated. Use apprt-core/string-escape instead.

Settings

Member Visibility

Theme

Generated using TypeDoc