Giter Club home page Giter Club logo

app-mutex.ts's Introduction

app-mutex.ts

Build Status Dependencies Dev Dependencies

Application Mutex locker implementation for TypeScript ๐Ÿข

Install

yarn add app-mutex

Usage

import { Mutex } from "app-mutext";

new Mutex("4cdb4d66-2d29-47fd-adaa-b2e8e72a6803", (status) => {
    switch (status) {
        case "CLEAR": break; // its ok
        case "PID_DEAD": // warning
            console.log("last time app ran, a critical error occurred.")
            break;
        case "CONFLICT":
            console.log("[ERR] app already running.");
            process.exit(-1);
            break;
    }
});


/* ... */

your code...

Then run your code in two instances, start only one. ๐Ÿ˜ฑ

Posible status of mutex

/**
 * Mutext status type
 * @argument ERR_NOT_INIT - Mutex not been initiated
 * @argument CLEAR        - Mutex status - success, you can run application
 * @argument CONFLICT     - Mutex detected runned this application
 * @argument PID_DEAD     - Mutex was noticed that the application died
 */

Why use it

  1. When you need to protect your system from running two or more instances of your program
  2. When to know if your instance is running ๐Ÿ˜

License

MIT

app-mutex.ts's People

Contributors

0xf6 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.