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

simcity-loading-state

v1.0.0

Published

This npm package provides an easy way to display random loading messages from a predefined text file, similar to the ones seen in the popular SimCity game series. The package exports a function that generates random loading messages at a specified duratio

Downloads

1

Readme

SimCity Loading Messages

This npm package provides an easy way to display random loading messages from a predefined text file, similar to the ones seen in the popular SimCity game series. The package exports a function that generates random loading messages at a specified duration and emits an event when a new message is generated.

Installation

Install the package using npm:

npm install simcity-loading-state

or using yarn:

yarn add simcity-loading-state

Usage

Basic Example

import { getRandomMessage, messageEmitter } from "simcity-loading-state";

// Start generating random messages every 3 seconds
const cancelInterval = getRandomMessage(3, undefined);

// Listen for events and handle the random messages
messageEmitter.on("message", (message) => {
  console.log("Random Message:", message);
});

// Cancel the interval when you want to stop displaying messages
setTimeout(() => {
  cancelInterval();
}, 15000);

React JS Example

You can use the package in a React project as follows:

import React, { useState, useEffect } from "react";
import { getRandomMessage, messageEmitter } from "simcity-loading-state";

const RandomMessageComponent = () => {
  const [randomMessage, setRandomMessage] = useState("");

  useEffect(() => {
    const handleMessage = (message) => {
      setRandomMessage(message);
    };

    // Start generating random messages
    const cancelInterval = getRandomMessage(3, undefined);

    // Listen for events and update the state
    messageEmitter.on("message", handleMessage);

    // Clean up when the component is unmounted
    return () => {
      cancelInterval();
      messageEmitter.removeListener("message", handleMessage);
    };
  }, []);

  return (
    <div>
      <h2>Random Message:</h2>
      <p>{randomMessage}</p>
    </div>
  );
};

export default RandomMessageComponent;

API

getAllMessages(): string[]

This function retrieves all messages from the loadingMessages.txt file and returns them as an array of strings.

getRandomMessage(duration: number, numberOfMessages?: number): () => void

This function displays random loading messages from the loadingMessages.txt file at a specified duration (in seconds). If numberOfMessages is provided, it limits the number of messages displayed. It returns a function that can be invoked to clear the interval and stop displaying messages.

messageEmitter: EventEmitter

This instance of EventEmitter emits a "message" event with the random message as the event payload when a new message is generated.

Thanks

A big thank you to Erik Cox for collating the list of loading states that I was able to use.

License

MIT