Giter Club home page Giter Club logo

do-not-disturb's Introduction

Do Not Disturb

npm npm

A simple API for managing "Do Not Disturb" mode.

Currently only MacOS is supported.

Installation

  $ npm install @theunderscorer/do-not-disturb

Why this exists

There are already plenty of packages for managing "Do Not Disturb" mode, however I was not able to get them to work on latest MacOS version (Big Sur) hence I've created this package :P.

For MacOS Montrey it uses a combo of macos-focus-mode for toggling DnD mode, and macos-notification-state for checking if DnD mode is enabled or not.

It also supports older MacOS versions via @sindresorhus/do-not-disturb package used as fallback.

Usage

import {
  enable,
  disable,
  toggle,
  isEnabled,
  installRequired,
  install
} from '@theunderscorer/do-not-disturb';

// Enables "Do Not Disturb" mode
await enable();

// Disables "Do Not Disturb" mode
await disable();

// Toggles "Do Not Disturb" mode
await toggle();

// Returns "true" if "Do Not Disturb" mode is enabled
await isEnabled();

// Returns "true" if driver needs to be installed (which is a case for MacOS Montrey)
await installRequired();

// Installs DnD driver if it is required. If not, does nothing.
await install();

Development

The package is written in typescript. In order to build it run:

  $ npm run build

To run tests (will run only on MacOS) run:

  $ npm run test

Future plans

  • Support Linux and Windows
  • Test Suite for CI

do-not-disturb's People

Contributors

semantic-release-bot avatar theunderscorer avatar

Watchers

 avatar  avatar

Forkers

coleby

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.