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

zustand-types

v0.1.0

Published

Infer zustand store type

Downloads

289

Readme


According to zustand documentation, it's impossible to infer the store type implicitly.

zustand-types utilizes an unconventional technique to correctly infer the store type both within and outside the store function. This method works perfectly under freshly released TypeScript 5, even in strict mode.

Installation

npm install -D zustand-types
yarn add -D zustand-types

Most use cases

Extract a store as a named function and provide SetState<typeof MyStore> type. That's it!

import {create} from "zustand"
import {SetState} from "zustand-types"

function MyStore(set: SetState<typeof MyStore>) {
  return {
    pets: [] as string[],
    // state: correctly inferred
    addPet: (pet: string) => set((state) => [...state.pets, pet]),
  }
}

// useStore: correctly inferred
export const useStore = create(MyStore)

Complete type signature

In case you need two other parameters, get and store, their types are also provided.

import {create} from "zustand"
import {SetState, GetState, Store} from "zustand-types"

function MyStore(
  set: SetState<typeof MyStore>,
  get: GetState<typeof MyStore>,
  store: Store<typeof MyStore>,
) {
  const state = get()
  const unsubscribe = store.subscribe((state) => {})
  return {
    //...
  }
}

export const useStore = create(MyStore)

Slice pattern

Slice pattern is a way to split your big store into multiple stores.

zustand-types provides a single type StoreArgs that captures all three arguments .

import {create} from "zustand"
import {StoreArgs} from "../src"

// Option A
function Store1(...args: StoreArgs<typeof Store1>) {
  const [set] = args
  return {
    x: 1,
    setX: (x: number) => set({x}),
  }
}

// Option B
function Store2(set: SetState<typeof Store2>, ...args: any[]) {
  return {
    y: 1,
    setY: (y: number) => set({y}),
  }
}

function Combined(...args: StoreArgs<typeof Combined>) {
  const state1 = Store1(...args)
  const state2 = Store2(...args)
  // Each slice state must be assigned to a variable, otherwise `Combined` return type will become implicit `any`.
  return {...state1, ...state2}
}

export const useStore = create(Combined)