npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typesafe-url-generator

v1.1.0

Published

A simple API for creating a type-safe urls

Downloads

6

Readme

Typesafe URL Generator

Package for creating typesafe urls

Getting started

You can install this package via running npm install typesafe-url-generator in your local application directory

Example Usage

// apiConfig.ts
import { createURLGenerator, type URLGeneratorConfig } from 'typesafe-url-generator';

const config = {
  products: {
    environments: {
      local: 'http://localhost:3000',
      development: 'https://dev',
      production: 'https://prod',
    },
    requests: {
      getProducts: '/products',
      getProduct: '/products/:id',
      getProductsByCategory: '/products/category?page=&limit=10',
    },
  },
} as const satisfies URLGeneratorConfig;

export const { generateUrl } = createURLGenerator(
  config,
  'development'
);

// someRequestFile.ts
import { generateUrl } from './apiConfig.ts'

const requestWithParams = generateUrl({
  api: 'products',
  request: 'getProducts',
});

const requestWithParams = generateUrl({
  api: 'products',
  request: 'getProduct',
  replace: {
    id: '1337', // Required
  },
});

const requestWithFilters = generateUrl({
  api: 'products',
  request: 'getProductsByCategory',
  // Optional
  filters: {
    page: '1', // Will be removed from the url if not set
    // limit: '10' Will default to 10 as defined in the config
  },
});