https://github.com/alii/pathcat

Simply path/URL building in JavaScript
https://github.com/alii/pathcat

http networking nodejs typescript urls utility

Last synced: about 4 hours ago
JSON representation

Simply path/URL building in JavaScript

• Host: GitHub
• URL: https://github.com/alii/pathcat
• Owner: alii
• License: unlicense
• Created: 2023-12-26T05:29:56.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-07-09T11:59:34.000Z (3 months ago)
• Last Synced: 2024-07-09T19:01:23.443Z (3 months ago)
• Topics: http, networking, nodejs, typescript, urls, utility
• Language: TypeScript
• Homepage: https://npm.im/pathcat
• Size: 1.02 MB
• Stars: 122
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `pathcat` 🐾

Simply path/URL building in JavaScript. Intelligently handles URL params and query strings.

This library owes thanks to urlcat, but unfortunately it seems to be abandoned. You can mostly use pathcat as a replacement.

## Features

- Very intuitive API

- Supports URL params and query string

- Avoids double slashes

- Zero dependencies

- Absolutely tiny install size

## Install

```sh

yarn add pathcat

```

## Usage

```typescript

import { pathcat } from "pathcat";

pathcat("https://example.com", "/:id", {

	id: 123,

});

// => 'https://example.com/123'

pathcat("https://example.com", "/:id", {

	id: "123",

	foo: "bar",

});

// => 'https://example.com/123?foo=bar'

// Base URL is optional, works on just paths as well.

pathcat("/users/:user_id/posts/:post_id", {

	user_id: "123",

	post_id: 456,

	cool_flag: true,

});

// => '/users/123/posts/456?cool_flag=true'

// You can also use arrays for query string values

pathcat("/users/:user_id/posts/:post_id", {

	user_id: "123",

	post_id: 456,

	cool_flag: true,

	fields: ["title", "body"],

});

// => '/users/123/posts/456?cool_flag=true&fields=title&fields=body'

```

## Benchmark:

Results when running on an M3 Max

```

$ node --import=tsx benchmark.ts

With a base URL x 1,446,429 ops/sec ±0.55% (94 runs sampled)

With no base URL x 1,494,634 ops/sec ±0.43% (98 runs sampled)

With a base URL, and no params x 2,720,270 ops/sec ±0.36% (93 runs sampled)

```

## Notes:

- Any params or query string values that are `undefined` will be omitted.

- Params that were not specified in the object will be left as is.