# get-uri > Returns a `stream.Readable` from a URI string Latest version **8.0.1** (published 2026-06-08) · MIT license · 0 weekly downloads ## Install ```sh npm install get-uri pnpm add get-uri yarn add get-uri bun add get-uri ``` ## Health **Score 60/100 (C)** — status: active. Positive: esm support; no vulnerabilities; has provenance; high maintenance score. Warnings: low downloads; no types. ## Facts | | | |---|---| | Version | 8.0.1 | | Published | 2026-06-08 | | First published | 2014-01-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM | | Node | >= 20 | | Dependencies | 3 | | Unpacked size | 43.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 1163 | | Author | Nathan Rajlich | | Maintainers | tootallnate | | Keywords | uri, read, readstream, stream, get, http, https, ftp, file, data, protocol, url | ## Links - npm: https://www.npmjs.com/package/get-uri - Repository: https://github.com/TooTallNate/proxy-agents - Homepage: https://github.com/TooTallNate/proxy-agents#readme - Issues: https://github.com/TooTallNate/proxy-agents/issues - npm.io page: https://npm.io/package/get-uri ## Dependencies (3) - [debug](https://npm.io/package/debug.md) ^4.3.4 - [basic-ftp](https://npm.io/package/basic-ftp.md) ^5.3.1 - [data-uri-to-buffer](https://npm.io/package/data-uri-to-buffer.md) 8.0.0 ## Alternatives - [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads - [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads - [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads - [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads - [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads ## Recent versions - 8.0.1 (latest) — 2026-06-08 - 8.0.0 — 2026-04-01 - 7.0.0 — 2026-03-11 - 6.0.5 — 2025-07-07 - 6.0.4 — 2024-12-03 - 6.0.3 — 2024-02-12 - 6.0.2 — 2023-09-30 - 6.0.1 — 2023-05-05 - 6.0.0 — 2023-05-04 - 5.0.0 — 2023-04-26 - 4.0.0 — 2021-09-23 - 3.0.2 — 2020-04-09 - 3.0.1 — 2020-02-10 - 3.0.0 — 2020-02-07 - 2.0.4 — 2019-10-10 - … 11 more at https://npm.io/package/get-uri/versions ## README get-uri ======= ### Returns a `stream.Readable` from a URI string This high-level module accepts a URI string and returns a `Readable` stream instance. There is built-in support for a variety of "protocols", and it's easily extensible with more: | Protocol | Description | Example |:---------:|:-------------------------------:|:---------------------------------: | `data` | [Data URIs][data] | `data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D` | `file` | [File URIs][file] | `file:///c:/windows/example.ini` | `ftp` | [FTP URIs][ftp] | `ftp://ftp.kernel.org/pub/site/README` | `http` | [HTTP URIs][http] | `http://www.example.com/path/to/name` | `https` | [HTTPS URIs][https] | `https://www.example.com/path/to/name` Example ------- To simply get a `stream.Readable` instance from a `file:` URI, try something like: ```ts import { getUri } from 'get-uri'; // `file:` maps to a `fs.ReadStream` instance… const stream = await getUri('file:///Users/nrajlich/wat.json'); stream.pipe(process.stdout); ``` Missing Endpoints ----------------- When you pass in a URI in which the resource referenced does not exist on the destination server, then a `NotFoundError` will be thrown. The `code` of the error instance is set to `"ENOTFOUND"`, so you can check for that value to detect when a bad filename is requested: ```ts try { await getUri('http://example.com/resource.json'); } catch (err) { if (err.code === 'ENOTFOUND') { // bad file path requested } else { // something else bad happened... throw err; } } ``` Cacheability ------------ When calling `getUri()` with the same URI multiple times, the `get-uri` module supports sending an indicator that the remote resource has not been modified since the last time it has been retrieved from that node process. To do this, define a `cache` property on the "options object" argument with the value set to the `stream.Readable` instance that was previously returned. If the remote resource has not been changed since the last call for that same URI, then a `NotModifiedError` instance will be thrown with its `code` property set to `"ENOTMODIFIED"`. When the `"ENOTMODIFIED"` error occurs, then you can safely re-use the results from the previous `getUri()` call for that same URI: ``` js // First time fetches for real const stream = await getUri('http://example.com/resource.json'); try { // … some time later, if you need to get this same URI again, pass in the // previous `stream.Readable` instance as `cache` option to potentially // have an "ENOTMODIFIED" error thrown: await getUri('http://example.com/resource.json', { cache: stream }); } catch (err) { if (err.code === 'ENOTMODIFIED') { // source file has not been modified since last time it was requested, // so you are expected to re-use results from a previous call to `getUri()` } else { // something else bad happened... throw err; } } ``` API --- ### getUri(uri: string | URL, options?: Object]): Promise A `uri` is required. An optional `options` object may be passed in: - `cache` - A `stream.Readable` instance from a previous call to `getUri()` with the same URI. If this option is passed in, and the destination endpoint has not been modified, then an `ENOTMODIFIED` error is thrown Any other options passed in to the `options` object will be passed through to the low-level connection creation functions (`http.get()`, `ftp.connect()`, etc). Returns a `stream.Readable` instance to read the resource at the given `uri`. [data]: http://tools.ietf.org/html/rfc2397 [file]: http://tools.ietf.org/html/draft-hoffman-file-uri-03 [ftp]: http://www.w3.org/Protocols/rfc959/ [http]: http://www.w3.org/Protocols/rfc2616/rfc2616.html [https]: http://wikipedia.org/wiki/HTTP_Secure --- _Source: https://npm.io/package/get-uri · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._