npmpackage.info

Gathering detailed insights and metrics for typed-url-params

Other packages similar to typed-url-params

react-router-url-params

0.9.0

Strongly-typed way to manage URL parameters in react-router

@getaround-eu/use-route-params

1.0.4

A hook to get typed params from route

react-nav-query-params

0.1.1

A react library for easily managing typed url query parameters.

typed-url-params

TypeSystem based parser for url parameters

1.0.1

TypeScript

172.00 B

271,723 2.5

Installations

npm install typed-url-params

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.16.0

NPM Version

6.14.11 Score

Supply Chain

92.4

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

3

Closed

0

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

1.0.1

Published on 08 Apr 2021

View all 1 releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

TypeScript

Makefile

TypeScript (93.25%)

Makefile (6.75%)

Developer

menduz

Download Statistics

Total Downloads

271,723

Last Day

Last Week

511

Last Month

5,475

Last Year

108,456

GitHub Statistics

86 Stars

3 Commits

3 Watching

3 Branches

1 Contributors

Bundle Size

205.00 B

Minified

172.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.1

Package Id

typed-url-params@1.0.1

Size

5.23 kB

NPM Version

6.14.11

Node Version

14.16.0

Publised On

08 Apr 2021

Total Downloads

Cumulative downloads

Total Downloads

271,723

Last day

-64.6%

Compared to previous day

Last week

-50.2%

511

Compared to previous week

Last month

-79.3%

5,475

Compared to previous month

Last year

-2.6%

108,456

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@microsoft/api-extractor expect path-to-regexp typescript

Versions

typed-url-params

Types your URL parameters in compliance with Express.js router and https://github.com/pillarjs/path-to-regexp

Install

npm install typed-url-params

Usage

1type Params = ParseUrlParams<"/test"> // { }
2type Params = ParseUrlParams<"/:abc"> // { abc: string }
3type Params = ParseUrlParams<"/:abc+"> // { abc: string | string[] }
4type Params = ParseUrlParams<"/:abc*"> // { abc?: string | string[] }
5type Params = ParseUrlParams<"/users/:userId"> // { userId: string }
6type Params = ParseUrlParams<"/flights/:from-:to"> // { from: string, to: string }

Usage with Express

This library only offers typings. You must write your own wrapper for Express. You can do it like this:

1function handleGet<TypedUrl extends string>(
2  app: Express.Application,
3  url: TypedUrl,
4  handler: (req: Express.Request & { params: ParseUrlParams<TypedUrl> }, res: Express.Response, next) => void
5) {
6  // noop
7}

More examples

1
2import { ParseUrlParams } from "typed-url-params"
3
4function assert<T extends string = string>(r: ParseUrlParams<T>): asserts r is ParseUrlParams<T> {}
5
6assert<"/:asd/b">({ asd: "" })
7assert<"/xxx/:asd/bbb:dsa">({ asd: "", dsa: "" })
8assert<"/xxx/:asd/bbb/:dsa">({ asd: "", dsa: "" })
9assert<"/xxx/:asd/bbb/:dsa">({ asd: "", dsa: "" })
10assert<"/:test*-bar">({ test: [] })
11assert<"/:test*-bar">({})
12assert<"/:test*-bar">({ test: "asd" })
13assert<"/:test*-bar">({ test: ["asd"] })
14assert<"/:test+-bar">({ test: [""] })
15assert<"/:test*">({ test: [] })
16assert<"/:test+">({ test: "" })
17assert<"/:test+">({ test: [""] })
18assert<"/:test?-bar">({ test: "" })
19assert<"/:test?">({ test: "" })
20assert<"/:test(\\d+)">({ test: "" })
21assert<"/:test(\\d+)+">({ test: "" })
22assert<"/:test(\\d+)+">({ test: [""] })
23assert<"/route.:ext(json|xml)?">({})
24assert<"/route.:ext(json|xml)?">({ ext: "" })
25assert<"/route.:ext(json|xml)">({ ext: "" })
26assert<"/route.:ext(json|xml)+">({ ext: "" })
27assert<"/route.:ext(json|xml)+">({ ext: [""] })
28assert<"/route.:ext([a-z]+)*/:asd">({ ext: [""], asd: "" })
29assert<"/route.:ext([a-z]+)*/:asd">({ asd: "" })
30assert<"/route.:ext([a-z]+)*">({ ext: [""] })
31assert<"/route.:ext([a-z]+)/:asd">({ ext: "", asd: "" })
32assert<"/:test(.*)">({ test: "" })
33assert<"/route\\(\\\\(\\d+\\\\)\\)">({})
34assert<"/{apple-}?icon-:res(\\d+).png">({ res: "" })
35assert<"/:foo/:bar">({ foo: "", bar: "" })
36assert<"/users/:user_id/:asd+">({ user_id: "", asd: [] })
37assert<"/flights/:from-:to">({ from: "", to: "" })

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Token-Permissions

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

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

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

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Security-Policy

Determines if the project has published a security policy.

Score

2.5

/10

Last Scanned on 2024-07-08

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