sindresorhus / do-not-disturb

Control the macOS `Do Not Disturb` feature

do-not-disturb

Control the macOS Do Not Disturb feature

Note that this package does not work inside a sandboxed app.

If you want to see an official API for this, please copy-paste the following into a new Feedback Assistant report, and submit it to Apple. Apple uses duplicates as an indication for how popular a request is.

Install

npm install @sindresorhus/do-not-disturb

Usage

import doNotDisturb from '@sindresorhus/do-not-disturb';

await doNotDisturb.enable();

API

doNotDisturb

All the methods return a Promise. You only really need to await them if you use multiple methods at once.

.enable(): Promise<void>

.disable(): Promise<void>

.toggle(force?): Promise<void>

force

Type: boolean

Force it to be enabled/disabled.

.isEnabled(): Promise<boolean>

.on('change', listener, options): EventEmitter

Attach an event listener that gets called when the "Do Not Disturb" state changes.

options

Type: object

pollInterval

Type: number
Default: 3000

Interval in milliseconds at which the polling for the change event is made.

.off('change', listener): EventEmitter

Remove an event listener that was attached previously.

import doNotDisturb from '@sindresorhus/do-not-disturb';

const listener = status => {
	console.log(`Do Not Disturb status: ${status}`);
}

doNotDisturb.on('change', listener, {pollInterval: 100});

// …

doNotDisturb.off('change', listener);

Related

• do-not-disturb-cli - CLI for this module
• dark-mode - Control the macOS dark mode
• macos-wallpaper - Manage the desktop wallpaper
• file-icon - Get the icon of a file or app as a PNG image
• app-path - Get the path to an app
• More…

do-not-disturb's Issues

OSX Catalina: Command was killed with SIGKILL when calling doNotDisturb.isEnabled()

In the logs of our Electron based app, I see the following error in some users running macOS Catalina:

Command was killed with SIGKILL

It happens when calling await doNotDisturb.isEnabled().

Setting `do-not-disturb off` does not reflect dnd mode being off in the menubar

Using newly installed instance of 10.14 (Mojave) with do-not-disturb-cli v0.2.0 installed, do-not disturb off after previously setting do-not-disturb on does not seem to update the menubar icon to reflect that dnd mode is now off. I'm not sure if it actually is still on or not. It may just be that the icon isn't updating properly. Will work on verifying that.

At any rate, just wanted to file this issue in the event that others are experiencing this.

Monterey support

Looks like its not working with MacOS 12.0 Monterey

Stop using polling for the `change` event

Could use the same method of doing it as https://github.com/LinusU/DarkModeListener/blob/master/Sources/main.swift and https://github.com/LinusU/node-dark-mode-listener

Get DND state (as setting DND state) is not working anymore on mac os v.11 (Big Sur)

getDoNotDisturb is not working anymore on mac os v.11 (Big Sur) since they removed ~/Library/Preferences/ByHost/com.apple.notificationcenterui setting

Toggle needs to run twice to turn off

Followed the install steps on https://github.com/sindresorhus/do-not-disturb-cli

When I run dnd (alias of do-not-disturb toggle) it toggles successfully, but when I run it several times one after the other it has some problems.

It always enables the do not disturb mode, but it turns it off only after the 2nd time I run the command while the DND is on.

I reproduce this behaviour consistently every time.

Question regarding app sandboxing

Hi,

I love your project!

I had a question regarding App Sandboxing. How does your app bypass the need to grant permissions regarding modifying the user preferences? I'm trying to make a macOS app for fun that partially uses your library here. I'm hitting issues where after building in Xcode, I run it and it says it turned DnD on, but it doesn't look like it on my computer. I figured it must be a code signing or App Sandboxing issue.

It would be greatly appreciated if you had any insight on this while making this! Appreciate it.

Question: how long is dnd enabled for

Is it permanent or is there some max-value?

(also, $ dnd does not seem to work on the 3 computers I tested (this only relevant to the cli)

Electron path in development

Having some issues with the bin path in an electron app during development. The issue seems to be related to the line const bin = path.join(electronUtil.fixPathForAsarUnpack(__dirname), 'do-not-disturb'); in index.js.

If I change it to const bin = path.join(__dirname, '/node_modules/@sindresorhus/do-not-disturb/do-not-disturb'); it works.

Maybe this would support electron with and without asar while also working in node apps?

let bin = path.join(
  electronUtil.fixPathForAsarUnpack(__dirname),
  'do-not-disturb'
);

if (electronUtil.isElectron && !electronUtil.isUsingAsar) {
  bin = path.join(
    __dirname,
    '/node_modules/@sindresorhus/do-not-disturb/do-not-disturb'
  );
}