UNPKG

@cumulus/common/http.d.ts

Version:

612 BTypeScriptView Raw

1/**
2 * A collection of functions to make working with http easier
3 * @module
4 */
5import got from 'got';
6/**
7 * Download a file to disk
8 *
9 * @param {string} uri - the URI to request
10 * @param {string} destination - Where to store file locally
11 * @param {Object} [options] - additional download options
12 * @param {Object} [options.headers] - headers to include in the request
13 * @returns {Promise<undefined>} - resolves when the download is complete
14 */
15export declare const download: (uri: string, destination: string, options?: got.GotOptions<string | null>) => Promise<void>;
16//# sourceMappingURL=http.d.ts.map
\No newline at end of file

1	`/**`
2	`* A collection of functions to make working with http easier`
3	`* @module`
4	`*/`
5	`import got from 'got';`
6	`/**`
7	`* Download a file to disk`
8	`*`
9	`* @param {string} uri - the URI to request`
10	`* @param {string} destination - Where to store file locally`
11	`* @param {Object} [options] - additional download options`
12	`* @param {Object} [options.headers] - headers to include in the request`
13	`* @returns {Promise<undefined>} - resolves when the download is complete`
14	`*/`
15	`export declare const download: (uri: string, destination: string, options?: got.GotOptions<string \| null>) => Promise<void>;`
16	`//# sourceMappingURL=http.d.ts.map`
\	No newline at end of file