get-uri/dist/index.js

Returns a `stream.Readable` from a URI string

import createDebug from 'debug';
// Built-in protocols
import { data } from './data.js';
import { file } from './file.js';
import { ftp } from './ftp.js';
import { http } from './http.js';
import { https } from './https.js';
const debug = createDebug('get-uri');
export const protocols = {
    data,
    file,
    ftp,
    http,
    https,
};
const VALID_PROTOCOLS = new Set(Object.keys(protocols));
export function isValidProtocol(p) {
    return VALID_PROTOCOLS.has(p);
}
/**
 * Async function that returns a `stream.Readable` instance that will output
 * the contents of the given URI.
 *
 * For caching purposes, you can pass in a `stream` instance from a previous
 * `getUri()` call as a `cache: stream` option, and if the destination has
 * not changed since the last time the endpoint was retrieved then the callback
 * will be invoked with an Error object with `code` set to "ENOTMODIFIED" and
 * `null` for the "stream" instance argument. In this case, you can skip
 * retrieving the file again and continue to use the previous payload.
 *
 * @param {String} uri URI to retrieve
 * @param {Object} opts optional "options" object
 * @api public
 */
export async function getUri(uri, opts) {
    debug('getUri(%o)', uri);
    if (!uri) {
        throw new TypeError('Must pass in a URI to "getUri()"');
    }
    const url = typeof uri === 'string' ? new URL(uri) : uri;
    // Strip trailing `:`
    const protocol = url.protocol.replace(/:$/, '');
    if (!isValidProtocol(protocol)) {
        throw new TypeError(`Unsupported protocol "${protocol}" specified in URI: "${uri}"`);
    }
    const getter = protocols[protocol];
    return getter(url, opts);
}
//# sourceMappingURL=index.js.map