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

skroutes

v0.1.1

Published

skRoutes is a package with the intent of making the URL useable as a typesafe state store for sveltekit (a first class citizen). This intent means that this package makes sveltekit routes, route parameters, and url search parameters easy to manage with va

Downloads

25

Readme

skRoutes

skRoutes is a package with the intent of making the URL useable as a typesafe state store for sveltekit (a first class citizen). This intent means that this package makes sveltekit routes, route parameters, and url search parameters easy to manage with validation. Simplifies navigation by generating URLs for a chosen endpoint with necessary params and searchParams. Using this library will dramatically simplify url changing, as changes in teh URL will be reflected elsewhere as type errors.

Installation

npm install skroutes

pnpm add skroutes

Features

  • Typesafe URL generation based on a route configuration, params, and search params.
  • Easily generate new url with different parameters or searchParameters from current url.
  • Validation of route parameters and search parameters.
  • Fully typed params and search params for use throughout the application.
  • Use of nested search pararms.
  • Typescript validation of URL addresses (changing URLs will cause typescript errors).
  • Ability to access params and searchParams as a store, with automatic navigation (with debouncing)

Usage

Define your route configuration:

import { skRoutes } from 'skRoutes';
import { z } from 'zod';

export const { pageInfo, urlGenerator, serverPageInfo } = skRoutes({
	config: {
		'/[id]': {
			paramsValidation: z.object({ id: z.string() }).parse
		},
		'/server/[id]': {
			paramsValidation: z.object({ id: z.string() }).parse
		}
	},
	errorURL: '/error'
});

Use the urlGenerator function to generate URLs:

const url = urlGenerator({ address: '/[id]', paramsValue: { id: 'Horse' } }).url;

Display the generated URL in your Svelte component (note that this includes the current`` url, as well as updateParams` which generates a url based on updated parameters):

<script lang="ts">
	import { pageInfo, urlGenerator } from '../routeConfig.js';
	import { page } from '$app/stores';

	$: urlInfo = pageInfo('/[id]', $page);
	const options = ['Horse', 'Donkey', 'Cat', 'Dog'];
</script>

<div class="page">
	{JSON.stringify(urlInfo.current)}
	<div class="item-row">
		{#each options as currentOption}
			<a href={urlInfo.updateParams({ params: { id: currentOption } }).url}>{currentOption}</a>
		{/each}
	</div>
</div>

Error Handling and errorURL

skRoutes provides a mechanism to handle errors gracefully through the errorURL configuration. When an error occurs during URL generation, the library will redirect to the specified errorURL with an error message appended as a query parameter.

How errorURL Works

When defining your route configuration, specify an errorURL:

export const { pageInfo, urlGenerator, serverPageInfo } = skRoutes({
	config: {
		// ... your routes
	},
	errorURL: '/error'
});

If an error occurs during URL generation, the urlGenerator function will return an object with the error property set to true and the url property set to the errorURL with an appended error message.

You can then handle this error in your application by checking the error property and displaying the appropriate error message or redirecting to the error page.

Safe Validation

It's crucial to ensure that your validation functions fail safely. If a validation error occurs, it should not crash your application but instead provide meaningful feedback or redirect to the errorURL.

If you're using zod for validation, it's recommended to use the .catch functionality to handle validation errors gracefully:

const validation = z.object({ id: z.string() }).catch({id: "default"}});

By following these practices, you can ensure a smooth user experience even in the face of unexpected input or errors.

Documentation

For more detailed documentation and advanced usage, please refer to the source code and examples provided in the Github repository.