Gathering detailed insights and metrics for itty-router
Gathering detailed insights and metrics for itty-router
Installations
npm install itty-routerDeveloper
kwhitley
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
Yes
Node Version
NPM Version
Statistics
1,804 Stars
707 Commits
79 Forks
14 Watching
37 Branches
31 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (97.85%)
JavaScript (2.15%)
Total Downloads
Cumulative downloads
Total Downloads
3,782,576
Last day
-8.4%
10,645
Compared to previous day
Last week
4.7%
62,795
Compared to previous week
Last month
9.4%
255,193
Compared to previous month
Last year
49.3%
2,010,123
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
26
@cloudflare/workers-types@rollup/plugin-multi-entry@rollup/plugin-terser@rollup/plugin-typescript@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parser@vitest/coverage-v8@whatwg-node/servercoverallseslinteslint-config-prettierfs-extraglobbyhttpjsdomprettierrimrafrolluprollup-plugin-bundle-sizerollup-plugin-copyrollup-plugin-multi-inputtypescriptvitevitestyarn-release
Versions
v5 Documentation | v4 -> v5 Migration Guide | Discord
An ultra-tiny API microrouter, for use when size matters (e.g. Cloudflare Workers).
Features
- Tiny. Routers from ~450 bytes to a ~970 bytes batteries-included version (~240-500x smaller than Express.js).
- TypeScript. Powerfully (and flexibly) typed for any environment.
- Route-parsing & query parsing.
- Middleware. Use ours or write your own.
- 100% Test Coverage. Bulletproof for production peace-of-mind.
- Designed specifically for serverless (but works anywhere).
- No assumptions. Return anything; pass in anything.
- Future-proof. HTTP methods not-yet-invented already work with it.
Example
1import { AutoRouter } from 'itty-router' // ~1kB 2 3const router = AutoRouter() 4 5router 6 .get('/hello/:name', ({ name }) => `Hello, ${name}!`) 7 .get('/json', () => [1,2,3]) 8 .get('/promises', () => Promise.resolve('foo')) 9 10export default router 11 12// that's it ^-^
Need Help?
Complete API documentation is available on itty.dev, or join our Discord channel to chat with community members for quick help!
Join the Discussion!
Have a question? Suggestion? Idea? Complaint? Want to send a gift basket? Join us on Discord!
A Special Thanks :heart:
As the community and contributor list has grown (and thus an individualized list here is no longer easily maintainable), I'd like to thank each and every one of you for making itty far greater than its humble origins. The robustness you see today, the careful consideration of every byte spent on features, the API choices, the code-golfing itself... are all thanks to the efforts and feedback from the community. I'd especially like to thank the core contributors and PR-authors, as well as the fantastic folks on the itty Discord group, for their tireless work refining this little beast and answering community questions.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
7 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 2/27 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/coveralls.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/verify.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coveralls.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/coveralls.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coveralls.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/coveralls.yml/v5.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/coveralls.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/coveralls.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/lint.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/lint.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/release.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/release.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/verify.yml/v5.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/kwhitley/itty-router/verify.yml/v5.x?enable=pin
- Info: 0 out of 8 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
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
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 7 are checked with a SAST tool
Score
3.1
/10
Last Scanned on 2024-11-18
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