ServiceWorkerRegistration.Update() should return Promise<ServiceWorkerRegistration>

[ahardin13]

TypeScript Version: 3.4.3

Search Terms:
ServiceWorkerRegistration Update

Code

// A *self-contained* demonstration of the problem follows...
// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc.
let isUpdating: boolean;
navigator.serviceWorker.getRegistration().then(sw => {
    sw.update().then(result => {
        if (result.installing || result.waiting) {
            isUpdating = true;
        }
    });
});

Expected behavior:
result is of type ServiceWorkerRegistration and result.installing and result.waiting are valid.
https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/update

Actual behavior:
result is of type void and tsc gives errors
error TS2339: Property 'installing' does not exist on type 'void'.
error TS2339: Property 'waiting' does not exist on type 'void'.

Playground Link

Related Issues:
#17590

[ahardin13]

It looks to me like this definition is what needs to be updated.

TypeScript/lib/lib.webworker.d.ts

Line 2721 in 00bf32c

update(): Promise<void>;

[ahardin13]

After digging through how the changes would be made, I found the typescript definition matches the w3c spec. https://w3c.github.io/ServiceWorker/#serviceworkerregistration

Any guidance on if I should follow-up on that spec or stick with the current definition and not use Chrome's implementation?

[MartinJohns]

On MDN they write for Chrome:

Starting with Chrome 46, update() returns a promise that resolves with 'undefined' if the operation completed successfully or there was no update, and rejects if update failed. If the new worker ran but installation failed, the promise still resolves. Formerly, it raised an exception.

[olback]

On MDN they write for Chrome:

Starting with Chrome 46, update() returns a promise that resolves with 'undefined' if the operation completed successfully or there was no update, and rejects if update failed. If the new worker ran but installation failed, the promise still resolves. Formerly, it raised an exception.

This seems to have changed. Running the update method in Chromium 77, I get a ServiceWorkerRegistration object back.

Edit: Tried it in Firefox 69 as well, same result as in Chromium 77.

[dlech]

It looks like this need to be fixed here: https://github.com/microsoft/TypeScript-DOM-lib-generator

[Bashamega]

Duplicate of microsoft/TypeScript-DOM-lib-generator#1684