UNPKG

1.24 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17export interface TimerTripFn {
18 (): void;
19}
20export interface TimerMap {
21 [key: number]: TimerTripFn;
22}
23/**
24 * Stubs window.setTimeout and returns a map of the functions that were passed
25 * in (the map is mutable and will be modified as setTimeout gets called).
26 * You can use this to manually cause timers to trip. The map is keyed by the
27 * duration of the timeout
28 */
29export declare function stubTimeouts(ids?: number[]): TimerMap;
30/**
31 * Similar to stubTimeouts, but for use when there's only one timeout you
32 * care about
33 */
34export declare function stubSingleTimeout(id?: number): TimerTripFn;