/
index.d.ts
136 lines (113 loc) · 3.11 KB
/
index.d.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
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
/**
* @license
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// WARNING: This is not a complete set of types exported by WebChannelWrapper.
// It is merely meant to support the usage patterns of the Firestore SDK.
export var EventType: {
COMPLETE: string;
};
export namespace WebChannel {
export var EventType: {
OPEN: string;
CLOSE: string;
ERROR: string;
MESSAGE: string;
};
}
export var Event: {
STAT_EVENT: string;
};
export var Stat: {
PROXY: number;
NOPROXY: number;
};
export var ErrorCode: {
NO_ERROR: number;
HTTP_ERROR: number;
TIMEOUT: number;
};
export interface Headers {
[name: string]: string | number;
}
export interface WebChannelError {
error?: { status: string; message: string };
}
export class XhrIo {
send(
url: string,
method?: string,
body?: string,
headers?: Headers,
timeoutInterval?: number
): void;
getLastErrorCode(): number;
getLastError(): string;
getStatus(): number;
getResponseText(): string;
getResponseJson(): WebChannelError | object;
listenOnce(type: string, cb: (param: unknown) => void): void;
}
export interface WebChannelOptions {
messageHeaders?: {
// To ensure compatibility with property minifcation tools, keys need to
// be listed explicity.
[k: string]: never;
};
initMessageHeaders?: {
// To ensure compatibility with property minifcation tools, keys need to
// be listed explicity.
[k: string]: never;
};
messageContentType?: string;
messageUrlParams?: {
database?: string;
};
clientProtocolHeaderRequired?: boolean;
concurrentRequestLimit?: number;
supportsCrossDomainXhr?: boolean;
sendRawJson?: boolean;
httpSessionIdParam?: string;
encodeInitMessageHeaders?: boolean;
forceLongPolling?: boolean;
detectBufferingProxy?: boolean;
fastHandshake?: boolean;
disableRedac?: boolean;
clientProfile?: string;
internalChannelParams?: {
forwardChannelRequestTimeoutMs?: number;
};
xmlHttpFactory?: unknown;
requestRefreshThresholds?: { [key: string]: number };
}
export interface EventTarget {
listen(type: string | number, cb: (param: unknown) => void): void;
}
export interface WebChannel extends EventTarget {
open(): void;
close(): void;
send(msg: unknown): void;
}
export interface StatEvent {
stat: number;
}
export interface WebChannelTransport {
createWebChannel(url: string, options: WebChannelOptions): WebChannel;
}
export function createWebChannelTransport(): WebChannelTransport;
export function getStatEventTarget(): EventTarget;
export class FetchXmlHttpFactory {
constructor(options: {});
}