url-pattern

Minified1.77 KBMinzipped761 B

Type-safe url pattern matching.

Example

Pattern

const matchPattern = urlPattern(
    "/api/:version{v1|v2}/users/:id?sort&order{asc|desc}",
);

const result = matchPattern("/api/v1/users/123?sort=name&order=asc");

Type

type Result =
    | undefined
    | {
          params: {
              version: "v1" | "v2";
              id: string;
          };
          search: {
              sort?: string;
              order?: "asc" | "desc";
          };
          raw: {
              hash: string;
              host: string;
              hostname: string;
              href: string;
              origin: string;
              password: string;
              pathname: string;
              port: string;
              protocol: string;
              search: string;
              username: string;
          };
      };

Result

const result = {
    params: { id: "123", version: "v1" },
    search: { order: "asc", sort: "name" },
    raw: {...},
};

Installation

npm

npm install @monstermann/url-pattern

pnpm

pnpm add @monstermann/url-pattern

yarn

yarn add @monstermann/url-pattern

bun

bun add @monstermann/url-pattern