mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
104 lines
2.8 KiB
TypeScript
104 lines
2.8 KiB
TypeScript
// Type definitions for wait-on 4.0
|
|
// Project: https://github.com/jeffbski/wait-on#readme
|
|
// Definitions by: Ifiok Jr. <https://github.com/ifiokjr>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.1
|
|
|
|
export = waitOn;
|
|
|
|
declare function waitOn(options: waitOn.WaitOnOptions): Promise<void>;
|
|
declare function waitOn(
|
|
options: waitOn.WaitOnOptions,
|
|
cb: (err: any) => void,
|
|
): void;
|
|
|
|
declare namespace waitOn {
|
|
interface WaitOnOptions {
|
|
/**
|
|
* Array of string resources to wait for. prefix determines the type of resource with the default type of file:
|
|
*/
|
|
resources: string[];
|
|
/**
|
|
* Initial delay in ms.
|
|
* @default 0
|
|
*/
|
|
delay?: number;
|
|
/**
|
|
* Poll resource interval in ms,
|
|
* @default 250ms
|
|
*/
|
|
interval?: number;
|
|
/**
|
|
* Flag which outputs to stdout, remaining resources waited on and when complete or any error occurs.
|
|
*/
|
|
log?: boolean;
|
|
/**
|
|
* Flag to reverse operation so checks are for resources being NOT available.
|
|
* @default false
|
|
*/
|
|
reverse?: boolean;
|
|
/**
|
|
* Timeout in ms until it aborts with error.
|
|
* @default Infinity
|
|
*/
|
|
timeout?: number;
|
|
/**
|
|
* http HEAD/GET timeout to wait for request
|
|
* @default 0
|
|
*/
|
|
httpTimeout?: number;
|
|
/**
|
|
* Tcp timeout in ms.
|
|
* @default 300
|
|
*/
|
|
tcpTimeout?: number;
|
|
/**
|
|
* Flag which outputs debug output.
|
|
* @default false
|
|
*/
|
|
verbose?: boolean;
|
|
/**
|
|
* Stabilization time in ms
|
|
* Waits this amount of time for file sizes to stabilize or other resource availability to remain unchanged.
|
|
* @default 750ms.
|
|
*/
|
|
window?: number;
|
|
/**
|
|
* Limit of concurrent connections to a resource
|
|
* @default Infinity
|
|
*/
|
|
simultaneous?: number;
|
|
/**
|
|
* Https specific option.
|
|
* see https:// github.com/request/request#readme for specific details
|
|
*/
|
|
auth?: WaitOnAuth;
|
|
httpSignature?: HttpSignature;
|
|
strictSSL?: boolean;
|
|
followAllRedirects?: boolean;
|
|
followRedirect?: boolean;
|
|
headers?: Record<string, any>;
|
|
}
|
|
|
|
interface HttpSignature {
|
|
keyId: string;
|
|
key: string;
|
|
}
|
|
|
|
type WaitOnAuth =
|
|
| {
|
|
username: string;
|
|
password: string;
|
|
}
|
|
| {
|
|
/**
|
|
* Alias of username
|
|
*/
|
|
user: string;
|
|
/**
|
|
* Alias of password
|
|
*/
|
|
pass: string;
|
|
};
|
|
}
|