Skip to content

fix(types): declare runtime URL and URLSearchParams globals #11482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aleclarson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(types): declare runtime URL and URLSearchParams globals #11482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions packages/types/globals.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/**
* Ambient declarations for JavaScript globals provided natively by the
* iOS and Android runtimes (ada-url based, see the runtime URLImpl and
* URLSearchParamsImpl sources), so they resolve in projects compiled
* without the DOM lib.
*
* The shapes intentionally mirror lib.dom.d.ts so the interfaces merge
* cleanly when a project also includes the DOM lib. Members that the
* runtimes do not implement (URL#toJSON, URL.parse, webkitURL, ...) are
* omitted; the URL constructor requires a string first argument because
* the runtimes throw a TypeError for anything else.
*/
interface URL {
hash: string;
host: string;
hostname: string;
href: string;
readonly origin: string;
password: string;
pathname: string;
port: string;
protocol: string;
search: string;
readonly searchParams: URLSearchParams;
username: string;
toString(): string;
}

interface URLConstructor {
new (url: string, base?: string | URL): URL;
prototype: URL;
canParse(url: string | URL, base?: string | URL): boolean;
/**
* Returns a `blob:nativescript/<uuid>` URL for a Blob/File, or null
* when the value is not a Blob/File instance.
*/
createObjectURL(object: any, options?: { ext?: string } | null): string | null;
revokeObjectURL(url: string): void;
}

declare var URL: URLConstructor;

interface URLSearchParams {
readonly size: number;
append(name: string, value: string): void;
delete(name: string, value?: string): void;
get(name: string): string | null;
getAll(name: string): string[];
has(name: string, value?: string): boolean;
set(name: string, value: string): void;
sort(): void;
toString(): string;
forEach(callbackfn: (value: string, key: string, parent: URLSearchParams) => void, thisArg?: any): void;
entries(): IterableIterator<[string, string]>;
keys(): IterableIterator<string>;
values(): IterableIterator<string>;
[Symbol.iterator](): IterableIterator<[string, string]>;
}

interface URLSearchParamsConstructor {
new (init?: string | string[][] | Record<string, string> | URLSearchParams | Iterable<readonly [string, string]>): URLSearchParams;
prototype: URLSearchParams;
}

declare var URLSearchParams: URLSearchParamsConstructor;
1 change: 1 addition & 0 deletions packages/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/// <reference path="./globals.d.ts" />
/// <reference types="@nativescript/types-android" />
/// <reference types="@nativescript/types-ios" />
3 changes: 2 additions & 1 deletion packages/types/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"url": "https://github.com/NativeScript/NativeScript"
},
"files": [
"index.d.ts"
"index.d.ts",
"globals.d.ts"
],
"license": "Apache-2.0",
"dependencies": {
Expand Down
Loading