Gathering detailed insights and metrics for typed-rest-client
Gathering detailed insights and metrics for typed-rest-client
Node Rest and Http Clients with typings for use with TypeScript
Installations
npm install typed-rest-clientDeveloper
Microsoft
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>= 16.0.0
Typescript Support
Yes
Node Version
18.20.4
NPM Version
10.7.0
Statistics
674 Stars
237 Commits
118 Forks
39 Watching
40 Branches
10,000 Contributors
Updated on 23 Nov 2024
Languages
TypeScript (85.42%)
JavaScript (14.58%)
Total Downloads
Cumulative downloads
Total Downloads
88,946,556
Last day
4.8%
136,717
Compared to previous day
Last week
0.2%
730,861
Compared to previous week
Last month
13.7%
3,077,984
Compared to previous month
Last year
29.3%
29,764,002
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
5
Versions
Typed REST and HTTP Client with TypeScript Typings
A lightweight REST and HTTP client optimized for use with TypeScript with generics and async await.
Features
- REST and HTTP client with TypeScript generics and async/await/Promises
- Typings included so no need to acquire separately (great for intellisense and no versioning drift)
- Basic, Bearer and NTLM Support out of the box. Extensible handlers for others.
- Proxy support
- Certificate support (Self-signed server and client cert)
- Redirects supported
Intellisense and compile support:
Install
npm install typed-rest-client --save
Or to install the latest preview:
npm install typed-rest-client@preview --save
Samples
See the samples for complete coding examples. Also see the REST and HTTP tests for detailed examples.
Errors
HTTP
The HTTP client does not throw unless truly exceptional.
- A request that successfully executes resulting in a 404, 500 etc... will return a response object with a status code and a body.
- Redirects (3xx) will be followed by default.
See HTTP tests for detailed examples.
REST
The REST client is a high-level client which uses the HTTP client. Its responsibility is to turn a body into a typed resource object.
- A 200 will be success.
- Redirects (3xx) will be followed.
- A 404 will not throw but the result object will be null and the result statusCode will be set.
- Other 4xx and 5xx errors will throw. The status code will be attached to the error object. If a RESTful error object is returned (
{ message: xxx}), then the error message will be that. Otherwise, it will be a generic,Failed Request: (xxx).
See REST tests for detailed examples.
Debugging
To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible:
export NODE_DEBUG=http
or
set NODE_DEBUG=http
Node support
v2 - [current, maintained] - Supports node 16 and above v1 - End Of Life, for Node < 16, contains security vulnerabilities, use at your own risk
Contributing
To contribute to this repository, see the contribution guide
To build:
1$ npm run build
To run all tests:
1$ npm test
To just run unit tests:
1$ npm run units
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Security Issues
Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Please don't report it here - let us know by sending an email to secure@microsoft.com.
Stable Version
The latest stable version of the package.
Stable Version
2.1.0
CRITICAL
1
CRITICAL
9.1/10
Summary
Potential leak of authentication data to 3rd parties
Affected Versions
< 1.8.0
Patched Versions
1.8.0
Reason
all changesets reviewed
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/autoAssignABTT.yml:1
- Warn: no topLevel permission defined: .github/workflows/stale.yml:1
- Info: no jobLevel write permissions found
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/autoAssignABTT.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/microsoft/typed-rest-client/autoAssignABTT.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/autoAssignABTT.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/microsoft/typed-rest-client/autoAssignABTT.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/microsoft/typed-rest-client/stale.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
13 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Score
5.5
/10
Last Scanned on 2024-11-25
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