/
types.ts
82 lines (82 loc) · 2.57 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
* The location (URL) of the object it is linked to. Changes done on it are reflected on the object it relates to.
* Both the Document and Window interface have such a linked Location, accessible via Document.location and Window.location respectively.
*
* Copy Location interface so that user's dont have to include dom typings with Tracing integration
* Based on https://github.com/microsoft/TypeScript/blob/4cf0afe2662980ebcd8d444dbd13d8f47d06fcd5/lib/lib.dom.d.ts#L9691
*/
export interface Location {
/**
* Returns a DOMStringList object listing the origins of the ancestor browsing contexts, from the parent browsing context to the top-level browsing context.
*/
readonly ancestorOrigins: DOMStringList;
/**
* Returns the Location object's URL's fragment (includes leading "#" if non-empty).
*
* Can be set, to navigate to the same URL with a changed fragment (ignores leading "#").
*/
hash: string;
/**
* Returns the Location object's URL's host and port (if different from the default port for the scheme).
*
* Can be set, to navigate to the same URL with a changed host and port.
*/
host: string;
/**
* Returns the Location object's URL's host.
*
* Can be set, to navigate to the same URL with a changed host.
*/
hostname: string;
/**
* Returns the Location object's URL.
*
* Can be set, to navigate to the given URL.
*/
href: string;
// tslint:disable-next-line: completed-docs
toString(): string;
/**
* Returns the Location object's URL's origin.
*/
readonly origin: string;
/**
* Returns the Location object's URL's path.
*
* Can be set, to navigate to the same URL with a changed path.
*/
pathname: string;
/**
* Returns the Location object's URL's port.
*
* Can be set, to navigate to the same URL with a changed port.
*/
port: string;
/**
* Returns the Location object's URL's scheme.
*
* Can be set, to navigate to the same URL with a changed scheme.
*/
protocol: string;
/**
* Returns the Location object's URL's query (includes leading "?" if non-empty).
*
* Can be set, to navigate to the same URL with a changed query (ignores leading "?").
*/
search: string;
/**
* Navigates to the given URL.
*/
assign(url: string): void;
/**
* Reloads the current page.
*/
reload(): void;
/** @deprecated */
// tslint:disable-next-line: unified-signatures completed-docs
reload(forcedReload: boolean): void;
/**
* Removes the current page from the session history and navigates to the given URL.
*/
replace(url: string): void;
}