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

gentleman-agnostic-signals

v0.0.4

Published

Hey there! ๐Ÿ‘‹ Welcome to the Signals Manager documentation. This README will guide you through using the `SignalsManager` class and its related modules.

Downloads

2

Readme

Signals Manager

Hey there! ๐Ÿ‘‹ Welcome to the Signals Manager documentation. This README will guide you through using the SignalsManager class and its related modules.

Introduction

The Signals Manager is a powerful utility for managing signals within your application. Signals, also known as events or messages, allow components or modules to communicate and react to changes or actions in a decoupled manner.

Installation

To use the Signals Manager in your project, follow these steps:

  1. Clone or download the repository.
  2. Install the required dependencies.
  3. Import the necessary modules into your project.

How to implement

import { initSignalsManager, SignalsState } from "gentleman-agnostic-signals";
// Define the keys you want to use for your signals
const StateProperties = {
  COUNT: "count",
  TEST: "test",
} as const;

// Define the Default Signals State Type you will use
type DefaultState = SignalsState<{
  [StateProperties.COUNT]: number;
  [StateProperties.TEST]: string;
}>;

// Create the default state
const defaultState: SignalsState<DefaultState> = {
  // Define your state properties here with their default values
  count: 0,
  test: "",
};

// Create the Signals Manager instance and enjoy !!
const signalsManager = initSignalsManager(defaultState);

// Now you can add, retrieve, and update signals as needed
// But !! only the signals declared at the "defaultState" object, if you try to use any key that is not already provided an error will occur by typescript

Usage

Retrieving a Signal

To retrieve a signal from the manager, use the getSignal method:

const mySignal = signalsManager.getSignal(StateProperties.COUNT);

Updating a Signal

To update a signal in the manager, use the updateSignal method:

signalsManager.updateSignal(StateProperties.COUNT, payload);

Conclusion

And that's it! You're now ready to start using the Signals Manager in your project. If you have any questions or need further assistance, feel free to reach out. Happy coding! ๐Ÿš€๐Ÿ””