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

lref

v1.0.3

Published

A better ref

Downloads

9

Readme

Lref() Vue3 ref() on steroids

lref() is a utility function for Vue 3 that extends the functionality of Vue's reactive reference ref(). It provides a set of convenient methods and properties for managing state, tracking history, and handling resets.

Installation

npm install lref

Usage

import { lref } from "lref";

const { countRef, countComputed, countReset, countInitial } = lref("count", 0);

// Access the reactive reference
console.log(countRef.value); // 0

// Use the computed property
console.log(countComputed.value); // 0

// Reset to initial value
countReset();

// Get the initial value
console.log(countInitial()); // 0
const { userRef, userUnConnected, userLastValueBeforeLastReset, userHistory } = lref("user", { name: "Lorens", age: 30 });

// Modify the reactive reference
userRef.value.name = "Ahmed";

// Access the unconnected copy
console.log(userUnConnected.value); // { name: 'Lorens', age: 30 }

// Get the last value before reset
console.log(userLastValueBeforeLastReset()); // null (or previous value if reset was called)

// Use history features
userHistory.undo();
userHistory.redo();
console.log(userHistory.data.value); // Array of historical states

API

The lref function returns an object with the following properties and methods:

  • ${name}Ref: The reactive reference (Ref)

  • ${name}Computed: A computed property based on the reference (ComputedRef)

  • ${name}Initial: Function that returns the initial value (() => T)

  • ${name}Reset: Function to reset the value to its initial state (() => void)

  • ${name}UnConnected: An unconnected copy of the reference (Ref<UnwrapRef>)

  • ${name}LastValueBeforeLastReset: Function that returns the last value before reset (() => T | null)

  • ${name}History: Object containing history-related methods and data

    • data: Ref to an array of historical states
    • undo: Function to undo the last change
    • redo: Function to redo the last undone change

Use Cases

  • Form Handling: Manage form state with easy reset capability.
  • Undo/Redo Functionality: Implement undo/redo in applications like text editors or drawing tools.
  • State Management: Keep track of state changes and provide rollback options.
  • Data Comparison: Compare current state with initial or previous states.
  • Debugging: Track the history of state changes for debugging purposes.

If you like this extension, feel free to support the development by buying a coffee: