[service_worker_api] remove fetch API interfaces and add new APIs by dolphin-wood · Pull Request #13664 · DefinitelyTyped/DefinitelyTyped

dolphin-wood · 2017-01-01T14:14:48Z

This PR removed the incompatible fetch API interfaces in respect to #12476 and #12582, and added new API interfaces as per Sercive Worker Draft.

@mohsen1 we have no choice but to merge the ServiceWorkerGlobalScope interface into Window, since there's no other global scopes. Meanwhile, some interfaces in ServiceWorkerGlobalScope, eg. onmessage, are not compatible with those in Window, I don't know if there are some workarounds other than rewriting them like:

interface ServiceWorkerGlobalScope {
    // onmessage: (messageevent: ExtendableMessageEvent) => void;
    onmessage: (messageevent: MessageEvent) => void;
}

Update: I found that lib.webworker.d.ts is using a /// <reference no-default-lib="true"/> directive to exclude the default lib, however when I tried adding the same directive to this lib, I got tons of type missing errors 😢.

Make your PR against the master branch.
Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Follow the advice from the readme.
Avoid common mistakes.
Run tsc without errors.
Run npm run lint package-name if a tslint.json is present.

Changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes: https://www.w3.org/TR/service-workers
Increase the version number in the header if appropriate.
If you are making substantial changes, consider adding a tslint.json containing { "extends": "../tslint.json" }.

resolve #12476, #12582

make `ServiceWorkerGlobalScope` interface compatible with `Window`

dt-bot · 2017-01-01T14:14:49Z

service_worker_api/index.d.ts

to author (@tristancaron). Could you review this PR?
👍 or 👎?

Checklist

pass the Travis CI test?

mohsen1

LGTM

ghost

Might be a good time to add linting. (Add tslint.json with { "extends": "../tslint.json" }.)

ghost · 2017-01-01T23:38:27Z

@@ -1,3 +1,5 @@
+/// <reference path="../whatwg-fetch/index.d.ts" />


/// <reference types="whatwg-fetch" />

ghost · 2017-01-01T23:39:09Z

+// TypeScript Version: 2.1

 // <reference path="../es6-promise/es6-promise.d.ts" /> // REMOVED third "/" so this doesn't fire. Problem with duplicate Promises
+// <reference path="../whatwg-fetch/index.d.ts" />


/// <reference types="whatwg-fetch" />

ghost · 2017-01-01T23:39:18Z

 // Definitions: https://github.com/borisyankov/DefinitelyTyped
+// TypeScript Version: 2.1

 // <reference path="../es6-promise/es6-promise.d.ts" /> // REMOVED third "/" so this doesn't fire. Problem with duplicate Promises


Then Travis will fail with compilation errors :/

Was referring to the commented-out reference.

ghost · 2017-01-01T23:42:34Z

     * push notification is received.
     *
     * @param [onpushevent]
     */


Jsdoc still indicates that the parameter is optional. (This is a good reason not to have redundant jsdoc annotations.)

dolphin-wood · 2017-01-02T21:48:27Z

@Andy-MS I just added "dt-header": false rule to tslint to pass the version lint, for there's no version for the service worker API. Will it be better to add a // tslint:disable-next-line dt-header annotation above the headers (I'm worried about breaking the format and, somehow, breaking the build process).

FYI:

// tslint:disable-next-line dt-header
// Type definitions for service_worker_api
// Project: https://developer.mozilla.org/fr/docs/Web/API/ServiceWorker_API
...

And I'm afraid I couldn't remove the TypeScript Version: 2.1 header now because I am using some features from ts2.1.

ghost · 2017-01-02T22:09:59Z

For the header, I would just write 0.0 there. We have to publish under some version, after all, and 0.0 will be inferred anyway if you don't write it.

dolphin-wood · 2017-01-02T22:16:12Z

@Andy-MS done.

ghost · 2017-01-02T22:18:04Z

Thanks!

dolphin-wood added 6 commits January 1, 2017 19:52

[service_worker_api] remove interfaces of fetch api

dd4e076

resolve #12476, #12582

[service_worker_api]: add missing api

6926b28

[service_worker_api]: add event interfaces

1e37f50

[service_worker_api]: add readonly modifier

54d4a41

[sercive_worker_api]: update onmessage interface

ee5558c

make `ServiceWorkerGlobalScope` interface compatible with `Window`

[service_worker_api]: update tests

eb532e7

dolphin-wood added 3 commits January 1, 2017 23:22

[service_worker_api]: fix compilation

23e90b8

[service_worker_api]: use ts2.1

2b8a12d

[service_worker_api]: fix header comments

f85462b

mohsen1 approved these changes Jan 1, 2017

View reviewed changes

dolphin-wood mentioned this pull request Jan 1, 2017

Service Worker typings microsoft/TypeScript#11781

Open

ghost reviewed Jan 1, 2017

View reviewed changes

dolphin-wood added 5 commits January 2, 2017 18:16

[service_worker_api]: fix reference with types=...

b85ace4

[service_worker_api]: add lints

03e1640

[service_worker_api]: fix lint issues

f7b5ac8

[service_worker_api]: add reference to whatwg-fetch

5ad239b

[service_worker_api]: fix jsdoc annotations

d2aa1b3

dolphin-wood added 2 commits January 3, 2017 07:11

[service_worker_api]: remove unnecessay comment

bb05a71

[service_worker_api]: add version 0.0

1197f07

ghost merged commit 0116564 into DefinitelyTyped:master Jan 2, 2017

brandingfuture mentioned this pull request Aug 30, 2023

[Snyk] Security upgrade mongoose from 6.3.9 to 6.12.0 brandingfuture/DefinitelyTyped#333

Open

MaxMood96 mentioned this pull request Sep 2, 2023

[Snyk] Security upgrade mongoose from 6.3.9 to 6.12.0 MaxMood96/DefinitelyTyped#533

Open

YoutacRandS-VA mentioned this pull request Oct 26, 2023

[Snyk] Security upgrade mongoose from 6.3.9 to 6.12.0 YoutacRandS-VA/DefinitelyTyped#30

Open

MaxMood96 mentioned this pull request Nov 6, 2023

[Snyk] Security upgrade mongoose from 6.3.9 to 6.12.0 MaxMood96/DefinitelyTyped#559

Open

This pull request was closed.

Navigation Menu

Repository navigation

[service_worker_api] remove fetch API interfaces and add new APIs - #13664

[service_worker_api] remove fetch API interfaces and add new APIs#13664
16 commits merged into
DefinitelyTyped:masterfrom
dolphin-wood:master

dolphin-wood commented Jan 1, 2017 •

edited

Loading

Uh oh!

dt-bot commented Jan 1, 2017

Uh oh!

mohsen1 left a comment

Uh oh!

ghost left a comment

Uh oh!

ghost Jan 1, 2017

Uh oh!

ghost Jan 1, 2017

Uh oh!

ghost Jan 1, 2017

Uh oh!

dolphin-wood Jan 2, 2017

Uh oh!

ghost Jan 2, 2017

Uh oh!

ghost Jan 1, 2017

Uh oh!

dolphin-wood commented Jan 2, 2017 •

edited

Loading

Uh oh!

ghost commented Jan 2, 2017

Uh oh!

dolphin-wood commented Jan 2, 2017

Uh oh!

ghost commented Jan 2, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -1,3 +1,5 @@
		/// <reference path="../whatwg-fetch/index.d.ts" />

Conversation

dolphin-wood commented Jan 1, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dt-bot commented Jan 1, 2017

Uh oh!

mohsen1 left a comment

Choose a reason for hiding this comment

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

ghost Jan 1, 2017

Choose a reason for hiding this comment

Uh oh!

ghost Jan 1, 2017

Choose a reason for hiding this comment

Uh oh!

ghost Jan 1, 2017

Choose a reason for hiding this comment

Uh oh!

dolphin-wood Jan 2, 2017

Choose a reason for hiding this comment

Uh oh!

ghost Jan 2, 2017

Choose a reason for hiding this comment

Uh oh!

ghost Jan 1, 2017

Choose a reason for hiding this comment

Uh oh!

dolphin-wood commented Jan 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Jan 2, 2017

Uh oh!

dolphin-wood commented Jan 2, 2017

Uh oh!

ghost commented Jan 2, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dolphin-wood commented Jan 1, 2017 •

edited

Loading

dolphin-wood commented Jan 2, 2017 •

edited

Loading