# electron-squirrel-startup

> Default Squirrel.Windows event handler for your Electron apps.

Latest version **1.0.1** (published 2024-05-13) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install electron-squirrel-startup
pnpm add electron-squirrel-startup
yarn add electron-squirrel-startup
bun add electron-squirrel-startup
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-05-13 |
| First published | 2015-07-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | separate (@types/electron-squirrel-startup) |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 236 |
| Author | Lucas Hrabovsky |
| Maintainers | orechova, himanshusinghs, c-buckingham, mongo-j, mabaasit, alexander_schroll, chuck.kalmanek, mongodb-js-user, rueckstiess, durran, lerouxb, fredtruman, mbroadst, hswolff, satyasinha, matt_d_rat, rhysm, tomhollander, alena.khineika, jeff-allen-mongo, mmarcon, jonathan.balsano, mongodb-build, jack.weir, stennie, mcasimir, kristina.stefano, jarjee, shaketbaby, devtoolsbot, addaleax, gribnoysup, mutukrish, imlucas |
| Keywords | mongodb.js, electron, electron-installer, squirrel.windows |

## Links

- npm: https://www.npmjs.com/package/electron-squirrel-startup
- Repository: https://github.com/mongodb-js/electron-squirrel-startup
- Homepage: http://github.com/mongodb-js/electron-squirrel-startup
- Issues: https://github.com/mongodb-js/electron-squirrel-startup/issues
- npm.io page: https://npm.io/package/electron-squirrel-startup

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^2.2.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-05-13
- 1.0.0 — 2016-05-19
- 0.2.0 — 2016-05-19
- 0.1.4 — 2015-09-01
- 0.1.3 — 2015-08-31
- 0.1.2 — 2015-07-11
- 0.0.1 — 2015-07-10
- 0.1.1 — 2015-07-10
- 0.1.0 — 2015-07-10

## README

# electron-squirrel-startup [![travis][travis_img]][travis_url] [![npm][npm_img]][npm_url] [![appveyor][appveyor_img]][appveyor_url]

> Default [Squirrel.Windows][squirrel] event handler for your [Electron][electron] apps.

## Installation

```
npm i electron-squirrel-startup
```

## Usage

To handle the most common commands, such as managing desktop shortcuts, just
add the following to the top of your `main.js` and you're good to go:

```js
if(require('electron-squirrel-startup')) return;
```
For Babel/ES6:

```js
const { app } = require('electron');
// ....
if(require('electron-squirrel-startup')) app.quit();
```

## Read More

### [Handling Squirrel Events][squirrel-events]
### [Squirrel.Windows Commands][squirrel-commands]

## License

Apache 2.0

[squirrel]: https://github.com/Squirrel/Squirrel.Windows
[electron]: https://github.com/atom/electron
[squirrel-commands]: https://github.com/Squirrel/Squirrel.Windows/blob/master/src/Update/Program.cs#L98
[squirrel-events]: https://github.com/atom/grunt-electron-installer#handling-squirrel-events
[appveyor_img]: https://ci.appveyor.com/api/projects/status/jljyvooqy91gbo7y?svg=true
[appveyor_url]: https://ci.appveyor.com/project/imlucas/electron-squirrel-startup
[travis_img]: https://img.shields.io/travis/mongodb-js/electron-squirrel-startup.svg
[travis_url]: https://travis-ci.org/mongodb-js/electron-squirrel-startup
[npm_img]: https://img.shields.io/npm/v/electron-squirrel-startup.svg
[npm_url]: https://npmjs.org/package/electron-squirrel-startup

---
_Source: https://npm.io/package/electron-squirrel-startup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._