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

homey-interval-manager

v1.1.2

Published

A utility class for managing intervals in Homey apps

Downloads

211

Readme

homey-interval-manager

A lightweight TypeScript library for managing intervals in Homey Apps, Devices and Drivers. Simplifies the process of scheduling and managing recurring tasks within your Homey applications.

Features

  • Easy interval management: Start, stop, and restart intervals with a simple API.
  • Flexible configuration: Define intervals with custom functions, settings, and intervals.
  • Automatic restarts: Optionally restart intervals when device settings change.
  • TypeScript support: Provides type definitions for improved code clarity and maintainability.

Installation

npm install homey-interval-manager

Usage

  1. Import the class:
import HomeyIntervalManager from "homey-interval-manager";
  1. Create an instance:
// In your device class constructor:
this.intervalManager = new HomeyIntervalManager(
    this,
    {
        SOME_KEY: {
            functionName: "myFunction", // Name of the function to execute
            settingName: "mySetting", // Optional setting to watch for changes
            intervalSeconds: 300, // Optional interval in seconds (default: 600)
            disableAutoStart: false, // Optional, prevent auto-start on device init
        },
        SOME_OTHER_KEY: {
            functionName: "myOtherFunction", // Name of the function to execute
        },
        // ... more interval configurations ...
    },
    600,
); // defaults to 10 minutes if no interval or setting name provided
  1. Start the intervals:
// Start all intervals (defined in the config)
await this.intervalManager.start();

// Or start specific intervals
await this.intervalManager.start("SOME_KEY", "SOME_OTHER_KEY");
  1. Stop the intervals:
// Stop all intervals
await this.intervalManager.stop();

// Or stop a specific interval
await this.intervalManager.clearInterval("myInterval");
  1. Restart intervals:
// Restart all intervals
await this.intervalManager.restart();

// Restart intervals associated with specific settings
await this.intervalManager.restart("mySetting");

Example

import OAuth2Device from "homey-oauth2app";
import HomeyIntervalManager from "homey-interval-manager";

class SomeCloudApiDevice extends OAuth2Device {
    private intervalManager: HomeyIntervalManager;

    async onOAuth2Init() {
        this.intervalManager = new HomeyIntervalManager(
            this,
            {
                STATUS_UPDATE: {
                    functionName: "syncStatusUpdate",
                    settingName: "status_update_polling_interval",
                },
            },
            600,
            true,
        );
        await this.intervalManager.start();
    }

    async syncStatusUpdate(): Promise<void> {
        const status = await this.get({ path: "/status" });
        await this.setCapabilityValue("device_status", status.name);
    }

    async onOAuth2Uninit() {
        await this.intervalManager.stop();
    }

    async onSettings({ oldSettings, newSettings, changedKeys }) {
        // perform your other tasks
        this.homey.setTimeout(async () => {
            await this.intervalManager.restart(...changedKeys);
        }, 1000);
    }
}

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

License

MIT