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

svelte-contextify

v1.0.4

Published

A tiny library for vastly improving context managament in Svelte apps by encapsulating the Context API.

Downloads

42

Readme

svelte-contextify

A tiny library for vastly improving context managament within your Svelte/SvelteKit apps by encapsulating the Context API.

Features

  • Removes the need for keys.
  • Removes key collisions by using the Symbol API.
  • Improves type safety when setting and getting context.
  • Improves error handling when retrieving unset context.

Installation

Install through npm using your preferred package manager:

npm i svelte-contextify
pnpm add svelte-contextify
yarn add svelte-contextify
bun add svelte-contextify

API

createContext(options)

See: source

The problem

Let's say we want to share the session of a user in our app through context, one might do that like so:

/** session.ts */

interface Session {
	username: string;
}

export type { Session };
<!-- App.svelte -->

<script lang="ts">
	import Component from '$lib/Component.svelte';
	import { setContext } from 'svelte';
	import type { Session } from '$lib/session.ts';

	setContext<Session>('session', { username: 'Hugos68' });
</script>

<Component />
<!-- Component.svelte -->

<script lang="ts">
	import { getContext } from 'svelte';
	import type { Session } from '$lib/session.ts';

	const session = getContext<Session>('session');
</script>
s
<p>Welcome: {session.username}!</p>

While this approach does work, it is flawed for two reasons:

  1. We need to keep track of the context key (session) in atleast two different places.
  2. We need to keep track of the Session type in atleast two different places.

How svelte-contextify solves the problem

This library aims to solve the problem by handling the key and type inference for you using the createContext function.

This allows you to refactor the code from above, into:

/** session.ts */

import { createContext } from 'svelte-contextify';

interface Session {
	username: string;
}

const {
	get: getSession,
	set: setSession
} = createContext<Session>({ defaultValue: { username: 'guest' } });

export { getSession, setSession };
export type { Session };
<!-- App.svelte -->

<script lang="ts">
	import Component from '$lib/Component.svelte';
	import { setSession } from '$lib/session.ts';

	setSession({ username: 'Hugos68' });
	//         ^ Type safety when setting context
</script>

<Component />
<!-- Component.svelte -->

<script lang="ts">
	import { getSession } from '$lib/session.ts';

	const session = getSession('session');
	//    ^ Type is inferred as Session
</script>

<p>Welcome: {session.username}!</p>

As you can see this notably improved using context as we now:

  • Don't need to define a key at all, which removes the need to keep the keys in sync.
  • Only have to pass the type once when creating the context, which removes the need from keeping the types in sync.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.