npmpackage.info

Gathering detailed insights and metrics for get-uri

Other packages similar to get-uri

timed-out

6.0.0

Timeout HTTP/HTTPS requests

registry-url

7.2.0

Get the set npm registry URL

got

14.4.7

Human-friendly and powerful HTTP request library for Node.js

jsonuri

3.4.5

Use URI path to get or set data

Gathering detailed insights and metrics for get-uri

get-uri - 6.0.4 | npmpackage.info

get-uri

Node.js HTTP Proxy Agents Monorepo

6.0.4

1,037

TypeScript

43.11 kB

1,611,058,924 3.6

Installations

npm install get-uri

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>= 14

Node Version

20.18.1

NPM Version

10.8.2 Pull Requests

Open

11

Total

183

Closed

60

Merged

112

Issues

Open

27

Total

177

Closed

150

Releases

pac-proxy-agent@7.2.0

Updated on Feb 18, 2025

agent-base@7.1.3

Updated on Dec 08, 2024

socks-proxy-agent@8.0.5

Updated on Dec 07, 2024

proxy-agent@6.5.0

Updated on Dec 07, 2024

pac-proxy-agent@7.1.0

Updated on Dec 07, 2024

https-proxy-agent@7.0.6

Updated on Dec 07, 2024

View All 76 releases

Languages

TypeScript

JavaScript

TypeScript (93.57%)

JavaScript (6.43%)

Developer

TooTallNate

Download Statistics

Total Downloads

1,611,058,924

Last Day

1,860,963

Last Week

11,482,063

Last Month

48,231,967

Last Year

483,626,011

GitHub Statistics

1,037 Stars

298 Commits

254 Forks

19 Watchers

3 Branches

40 Contributors

Updated on May 09, 2025

Maintainers

View All 40 Contributors

Package Meta Information

Latest Version

6.0.4

Package Id

get-uri@6.0.4

Unpacked Size

43.11 kB

Size

12.81 kB

File Count

NPM Version

10.8.2

Node Version

20.18.1

Published on

Dec 03, 2024

Total Downloads

Cumulative downloads

Total Downloads

1,611,058,924

Dependencies

basic-ftp data-uri-to-buffer debug

Dev Dependencies

@types/debug @types/ftpd @types/jest @types/node async-listen ftpd jest st ts-jest typescript tsconfig

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:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D`
`file`	File URIs	`file:///c:/windows/example.ini`
`ftp`	FTP URIs	`ftp://ftp.kernel.org/pub/site/README`
`http`	HTTP URIs	`http://www.example.com/path/to/name`
`https`	HTTPS URIs	`https://www.example.com/path/to/name`

Example

To simply get a stream.Readable instance from a file: URI, try something like:

1import { getUri } from 'get-uri';
2
3// `file:` maps to a `fs.ReadStream` instance…
4const stream = await getUri('file:///Users/nrajlich/wat.json');
5stream.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:

1try {
2  await getUri('http://example.com/resource.json');
3} catch (err) {
4  if (err.code === 'ENOTFOUND') {
5    // bad file path requested
6  } else {
7    // something else bad happened...
8    throw err;
9  }
10}

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:

1// First time fetches for real
2const stream = await getUri('http://example.com/resource.json');
3
4try {
5  // … some time later, if you need to get this same URI again, pass in the
6  // previous `stream.Readable` instance as `cache` option to potentially
7  // have an "ENOTMODIFIED" error thrown:
8  await getUri('http://example.com/resource.json', { cache: stream });
9} catch (err) {
10  if (err.code === 'ENOTMODIFIED') {
11    // source file has not been modified since last time it was requested,
12    // so you are expected to re-use results from a previous call to `getUri()`
13  } else {
14    // something else bad happened...
15    throw err;
16  }
17}

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.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

4

Maintained

Determines if the project is "actively maintained".

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:122: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:127: update your workflow using https://app.stepsecurity.io/secureworkflow/TooTallNate/proxy-agents/test.yml/main?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to get-uri

Other packages similar to get-uri

get-uri

Installations

Developer Guide

Yes

CommonJS

>= 14

20.18.1

10.8.2

Pull Requests

11

183

60

112

Issues

27

177

150

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

1,611,058,924

Dependencies

Dev Dependencies

get-uri

Returns a stream.Readable from a URI string

Example

Missing Endpoints

Cacheability

API

getUri(uri: string | URL, options?: Object]): Promise

10

10

5

4

2

0

0

0

0

0

0

0

3.6

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads

Returns a `stream.Readable` from a URI string