@stencila/jesta
Version:
Stencila plugin for executable documents using JavaScript
30 lines (29 loc) • 816 B
TypeScript
/**
* A utility module for HTTP requests
*
* Uses `got` to enable RFC 7234 compliant HTTP caching
*
* @module util/http
*/
import { Options, Response } from 'got';
/**
* A `got` instance with default options for HTTP requests.
*
* User agent is set, and includes a `mailto`, for politeness:
* https://github.com/CrossRef/rest-api-doc#good-manners--more-reliable-service
*/
export declare const client: import("got").Got;
/**
* Get content from a URL
*
* @param url The URL to get
* @param options Options to pass to `got`
*/
export declare function get(url: string, options?: Options): Promise<Response<string>>;
/**
* Download a file
*
* @param from The URL to download from
* @param to The file path to download to
*/
export declare function download(from: string, to: string): Promise<void>;