-
-
Notifications
You must be signed in to change notification settings - Fork 916
/
single-spa.d.ts
238 lines (209 loc) · 7.08 KB
/
single-spa.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
declare module "single-spa" {
interface CustomProps {
[str: string]: any;
[num: number]: any;
}
type CustomPropsFn<ExtraProps extends CustomProps = CustomProps> = (
name: string,
location: Location
) => ExtraProps;
export type AppProps = {
name: string;
singleSpa: any;
mountParcel(
parcelConfig: ParcelConfig,
customProps: ParcelProps & CustomProps
): Parcel;
};
export type ParcelConfig<ExtraProps = CustomProps> =
| ParcelConfigObject<ExtraProps>
| (() => Promise<ParcelConfigObject<ExtraProps>>);
type ParcelProps = { domElement: HTMLElement };
type ParcelConfigObject<ExtraProps = CustomProps> = {
name?: string;
} & LifeCycles<ExtraProps>;
type Parcel<ExtraProps = CustomProps> = {
mount(): Promise<null>;
unmount(): Promise<null>;
update?(customProps: ExtraProps): Promise<any>;
getStatus():
| "NOT_LOADED"
| "LOADING_SOURCE_CODE"
| "NOT_BOOTSTRAPPED"
| "BOOTSTRAPPING"
| "NOT_MOUNTED"
| "MOUNTING"
| "MOUNTED"
| "UPDATING"
| "UNMOUNTING"
| "UNLOADING"
| "SKIP_BECAUSE_BROKEN"
| "LOAD_ERROR";
loadPromise: Promise<null>;
bootstrapPromise: Promise<null>;
mountPromise: Promise<null>;
unmountPromise: Promise<null>;
};
type LifeCycleFn<ExtraProps> = (
config: ExtraProps & AppProps
) => Promise<any>;
export type LifeCycles<ExtraProps = {}> = {
bootstrap: LifeCycleFn<ExtraProps> | Array<LifeCycleFn<ExtraProps>>;
mount: LifeCycleFn<ExtraProps> | Array<LifeCycleFn<ExtraProps>>;
unmount: LifeCycleFn<ExtraProps> | Array<LifeCycleFn<ExtraProps>>;
update?: LifeCycleFn<ExtraProps> | Array<LifeCycleFn<ExtraProps>>;
};
export type StartOpts = {
urlRerouteOnly?: boolean;
};
// ./start.js
export function start(opts?: StartOpts): void;
// ./jquery-support.js
export function ensureJQuerySupport(jQuery?: any): void;
// ./applications/timeouts.js
/**
* Sets the timeout for the given lifecycle.
* @param {number} time - The timeout in milliseconds.
* @param {boolean=} dieOnTimeout - Whether to throw an error if the timeout is reached. Default false.
* @param {number=} warningMillis - The number of milliseconds before the timeout warning is triggered. Default 1000.
* @returns {void}
**/
export function setBootstrapMaxTime(
time: number,
dieOnTimeout?: boolean,
warningMillis?: number
): void;
/**
* Sets the timeout for the given lifecycle.
* @param {number} time - The timeout in milliseconds.
* @param {boolean=} dieOnTimeout - Whether to throw an error if the timeout is reached. Default false.
* @param {number=} warningMillis - The number of milliseconds before the timeout warning is triggered. Default 1000.
* @returns {void}
**/
export function setMountMaxTime(
time: number,
dieOnTimeout?: boolean,
warningMillis?: number
): void;
/**
* Sets the timeout for the given lifecycle.
* @param {number} time - The timeout in milliseconds.
* @param {boolean=} dieOnTimeout - Whether to throw an error if the timeout is reached. Default false.
* @param {number=} warningMillis - The number of milliseconds before the timeout warning is triggered. Default 1000.
* @returns {void}
**/
export function setUnmountMaxTime(
time: number,
dieOnTimeout?: boolean,
warningMillis?: number
): void;
/**
* Sets the timeout for the given lifecycle.
* @param {number} time - The timeout in milliseconds.
* @param {boolean=} dieOnTimeout - Whether to throw an error if the timeout is reached. Default false.
* @param {number=} warningMillis - The number of milliseconds before the timeout warning is triggered. Default 1000.
* @returns {void}
**/
export function setUnloadMaxTime(
time: number,
dieOnTimeout?: boolean,
warningMillis?: number
): void;
type Application<ExtraProps = {}> =
| LifeCycles<ExtraProps>
| ((config: ExtraProps & AppProps) => Promise<LifeCycles<ExtraProps>>);
type ActivityFn = (location: Location) => boolean;
type Activity = ActivityFn | string | (ActivityFn | string)[];
export type RegisterApplicationConfig<ExtraProps extends CustomProps = {}> = {
name: string;
app: Application<ExtraProps>;
activeWhen: Activity;
customProps?: ExtraProps | CustomPropsFn<ExtraProps>;
};
interface SingleSpaNewAppStatus {
[key: string]:
| "MOUNTED"
| "NOT_MOUNTED"
| "NOT_LOADED"
| "SKIP_BECAUSE_BROKEN";
}
interface SingleSpaAppsByNewStatus {
[MOUNTED]: string[];
[NOT_MOUNTED]: string[];
[NOT_LOADED]: string[];
[SKIP_BECAUSE_BROKEN]: string[];
}
export type SingleSpaCustomEventDetail = {
newAppStatuses: SingleSpaNewAppStatus;
appsByNewStatus: SingleSpaAppsByNewStatus;
totalAppChanges: number;
originalEvent?: Event;
oldUrl: string;
newUrl: string;
navigationIsCanceled: boolean;
cancelNavigation?: () => void;
};
// ./applications/apps.js
export function registerApplication<ExtraProps extends CustomProps = {}>(
appName: string,
applicationOrLoadingFn: Application<ExtraProps>,
activityFn: ActivityFn,
customProps?: ExtraProps | CustomPropsFn<ExtraProps>
): void;
export function registerApplication<ExtraProps extends CustomProps = {}>(
config: RegisterApplicationConfig<ExtraProps>
): void;
export function unregisterApplication(appName: string): Promise<any>;
export function getMountedApps(): string[];
export const {
NOT_LOADED = "NOT_LOADED",
LOADING_SOURCE_CODE = "LOADING_SOURCE_CODE",
NOT_BOOTSTRAPPED = "NOT_BOOTSTRAPPED",
BOOTSTRAPPING = "BOOTSTRAPPING",
NOT_MOUNTED = "NOT_MOUNTED",
MOUNTING = "MOUNTING",
MOUNTED = "MOUNTED",
UPDATING = "UPDATING",
UNMOUNTING = "UNMOUNTING",
UNLOADING = "UNLOADING",
SKIP_BECAUSE_BROKEN = "SKIP_BECAUSE_BROKEN",
LOAD_ERROR = "LOAD_ERROR",
};
export function getAppStatus(appName: string): string | null;
export function unloadApplication(
appName: string,
opts?: { waitForUnmount: boolean }
): Promise<any>;
export function checkActivityFunctions(location: Location): string[];
export function getAppNames(): string[];
// ./navigation/navigation-events.js'
export function navigateToUrl(
obj:
| string
| {
currentTarget: {
href: string;
};
preventDefault: any;
},
opts?: Object
): void;
// './navigation/reroute.js'
export function triggerAppChange(): Promise<any>;
// './applications/app-errors.js'
type AppError = Error & {
appOrParcelName: string;
};
export function addErrorHandler(handler: (error: AppError) => void): void;
export function removeErrorHandler(handler: (error: AppError) => void): void;
// './parcels/mount-parcel.js'
export function mountRootParcel<ExtraProps = CustomProps>(
parcelConfig: ParcelConfig<ExtraProps>,
parcelProps: ParcelProps & ExtraProps
): Parcel<ExtraProps>;
export function pathToActiveWhen(
path: string,
exactMatch?: boolean
): ActivityFn;
export function patchHistoryApi(opts?: StartOpts): void;
}