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

vue-immer-state

v1.0.4

Published

Vue state management using immer

Downloads

6

Readme

vue-immer-state

Purpose

vue-immer-state is a minimalistic approach for state management in Vue using immer.

Description

A State - in the sense of this library - is comprised of a reference to an immutable value, together with a method named commit to allow for changes to the value.

type State<T> = DeepReadonly<{
    ref: Ref<T>
    commit?: (updater: (value: T) => void) => void
}>

Let's begin with a simple example, how you would define the state of a User model:

import { createState } from 'vue-immer-state'

type User = { name: string }

const userState = createState<User>({ name: 'Foo' })

You can mutate its value by committing an update-method:

// before
console.log(userState.ref.value.name)
> 'Foo'

userState.commit?.(
    (user) => { user.name = 'Bar' }
)

// after
console.log(userState.ref.value.name)
> 'Bar'

For any details on how update-methods work, please take a look at the documentation of the great immer project: https://immerjs.github.io/immer/

If you define your state as readonly, or if you pass a readonly reference, createState will not provide you with a commit-method:

const userState = createState<User>(
  computed(() => appState.ref.value.user)
)

// or
const userState = createState<User>({ name: 'Foo' }, **true**)

// before
console.log(userState.ref.value.name)
> 'Foo'

// this has no effect
userState.commit?.(
    (user) => { user.name = 'Bar' }
)

// after
console.log(userState.ref.value.name)
> 'Foo'

Let's take a look at a more complex example and derive a User state from an App state:

import { createState } from 'vue-immer-state'

type User = { name: string }
type App  = { user: User }

const appState = createState<App>(
  { user: { name: 'Foo' } }
)

const userState = createState<User>(
  computed({
    get () { 
      return appState.ref.value.user 
    },
    set (value) { 
      appState.commit?.((app) => { app.user = value }) 
    }
  })
)

Now, whenever we commit changes to the User state, this in turn updates the App state instead. The changes then trickle down again to the reactive User state.

// before
console.log(userState.ref.value.name)
> 'Foo'
console.log(appState.ref.value.user.name)
> 'Foo'

userState.commit?.(
    (user) => { user.name = 'Bar' }
)

// after
console.log(userState.ref.value.name)
> 'Bar'
console.log(appState.ref.value.user.name)
> 'Bar'

For states to work as prop values, you need to define your components properties as such:

<script setup lang="ts">
  const { userState } = defineProps<{
    userState: State<User>
  }>()

  // extract the ref for template usage
  const user = userState.ref
</script>

<template>
  <div>User {{ user.name }}</div>
</template>

Now passing state is straightforward:

<User :user-state="userState" />

Installation

Use npm or yarn to install:

> npm i ntrpy/vue-immer-state

or 

> yarn add ntrpy/vue-immer-state

Have fun!