Type Alias NotificationUpdateCallback

Type Declaration

• • (
        update?: @param {string} [update.message] An update to the string message * @param {boolean} [update.localize=false] Localize updates to presented progress text * @param {boolean} [update.escape=true] See {@link NotificationOptions#escape} * @param {boolean} [update.clean=true] See {@link NotificationOptions#clean} * @param {Record<string, string>} [update.format] A mapping of formatting strings passed to Localization#format * @param {number} [update.pct] An update to the completion percentage * ,
    ): void

  • Parameters

    • Optionalupdate: @param {string} [update.message] An update to the string message * @param {boolean} [update.localize=false] Localize updates to presented progress text * @param {boolean} [update.escape=true] See {@link NotificationOptions#escape} * @param {boolean} [update.clean=true] See {@link NotificationOptions#clean} * @param {Record<string, string>} [update.format] A mapping of formatting strings passed to Localization#format * @param {number} [update.pct] An update to the completion percentage *

      An incremental progress update

    Returns void