url-pattern

Minified4.45 KBMinzipped1.69 KB

Type-safe url pattern matching.

Example

Pattern

const matchPattern = pathPattern("/api/:version{v1|v2}/users/:id");

const result = matchPattern("/api/v1/users/123");

Type

type Result =
    | undefined
    | {
          version: "v1" | "v2";
          id: string;
      };

Result

const result = { id: "123", version: "v1" };

Two functions

pathPattern matches the path only, and ignores the protocol and host entirely:

const matchPattern = pathPattern("/:workspaceId/task/:taskId");

matchPattern("/ws1/task/t1"); // {...}
matchPattern("https://anything.com/ws1/task/t1"); // {...}

urlPattern matches the whole url, and requires a protocol and a host:

const matchPattern = urlPattern("miko://:workspaceId/task/:taskId");

matchPattern("miko://ws1/task/t1"); // {...}
matchPattern("https://evil.com/ws1/task/t1"); // undefined

Reach for urlPattern whenever the origin is part of what you are asserting — deep links, webhooks, anything where a url from somewhere else must not be mistaken for one of yours.

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