userscripts/env.d.ts at master · IronKinoko/userscripts · GitHub

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/// <reference types="bocchi/env" />

interface Window {
  [x: string]: any
}

declare const unsafeWindow: Window
declare function GM_getValue<T>(key: string): T | undefined
declare function GM_getValue<T>(key: string, defaultValue: T): T
declare function GM_setValue(key: string, value: any): void

declare interface GMXMLHttpRequestDetails {
  /**
   * HTTP method
   * @default "GET"
   */
  method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS'

  /**
   * Request URL
   */
  url: string

  /**
   * Request headers
   */
  headers?: Record<string, string>

  /**
   * Request body
   */
  data?: string | Blob | ArrayBuffer | FormData

  /**
   * Response type
   */
  responseType?: '' | 'arraybuffer' | 'blob' | 'json' | 'text'

  /**
   * Timeout in milliseconds
   */
  timeout?: number

  /**
   * Whether to send cookies
   */
  anonymous?: boolean

  /**
   * Include cookies for the request
   */
  cookie?: string

  /**
   * Redirect handling
   */
  redirect?: 'follow' | 'error' | 'manual'

  /**
   * Override MIME type
   */
  overrideMimeType?: string

  /**
   * User-Agent
   */
  userAgent?: string

  /**
   * Progress callback
   */
  onprogress?: (response: GMXMLHttpRequestProgress) => void

  /**
   * Ready state change callback
   */
  onreadystatechange?: (response: GMXMLHttpRequestResponse) => void

  /**
   * Request completed
   */
  onload?: (response: GMXMLHttpRequestResponse) => void

  /**
   * Request failed
   */
  onerror?: (response: GMXMLHttpRequestResponse) => void

  /**
   * Timeout callback
   */
  ontimeout?: (response: GMXMLHttpRequestResponse) => void

  /**
   * Abort callback
   */
  onabort?: (response: GMXMLHttpRequestResponse) => void
}

declare interface GMXMLHttpRequestResponse<T = any> {
  /**
   * Final URL after redirects
   */
  finalUrl: string

  /**
   * XMLHttpRequest readyState
   */
  readyState: number

  /**
   * HTTP status code
   */
  status: number

  /**
   * HTTP status text
   */
  statusText: string

  /**
   * Response headers
   */
  responseHeaders: string

  /**
   * Response data
   */
  response: T

  /**
   * Response as text
   */
  responseText: string

  /**
   * XML document response
   */
  responseXML: Document | null
}

declare interface GMXMLHttpRequestProgress extends GMXMLHttpRequestResponse {
  lengthComputable: boolean
  loaded: number
  total: number
}

declare interface GMXMLHttpRequestAbortHandle {
  abort(): void
}

declare function GM_xmlhttpRequest<T = any>(
  details: GMXMLHttpRequestDetails
): GMXMLHttpRequestAbortHandle