# brightness

> Change the screen brightness

Latest version **3.0.0** (published 2016-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install brightness
pnpm add brightness
yarn add brightness
bun add brightness
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2016-01-06 |
| First published | 2015-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 192 |
| Author | Kevin Martensson |
| Maintainers | kevva, sindresorhus, gillstrom |
| Keywords | brightness, linux, osx, screen, windows, xdg |

## Links

- npm: https://www.npmjs.com/package/brightness
- Repository: https://github.com/kevva/brightness
- Homepage: https://github.com/kevva/brightness#readme
- Issues: https://github.com/kevva/brightness/issues
- npm.io page: https://npm.io/package/brightness

## Dependencies (5)

- [pify](https://npm.io/package/pify.md) ^2.3.0
- [nircmd](https://npm.io/package/nircmd.md) ^2.0.0
- [wmi-client](https://npm.io/package/wmi-client.md) ^0.2.0
- [osx-brightness](https://npm.io/package/osx-brightness.md) ^4.0.0
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) ^2.0.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2016-01-06
- 2.2.0 — 2015-07-17
- 2.1.0 — 2015-07-12
- 2.0.1 — 2015-07-06
- 2.0.0 — 2015-07-06
- 1.1.0 — 2015-06-19
- 1.0.1 — 2015-06-01
- 1.0.0 — 2015-05-22
- 0.1.0 — 2015-05-18

## README

<h1 align="center">
	<br>
	<img width="360" src="https://rawgit.com/kevva/brightness/master/media/logo.svg" alt="brightness">
	<br>
	<br>
	<br>
</h1>

> Change the screen brightness


## Install

```
$ npm install --save brightness
```


## Usage

```js
const brightness = require('brightness');

brightness.get().then(level => {
	console.log(level);
	//=> 0.5
});

brightness.set(0.8).then(() => {
	console.log('Changed brightness to 80%');
});
```


## API

### .get()

Returns a promise for the current brightness level.

### .set(level)

Set brightness level.

#### level

*Required*  
Type: `number`

A number between `0` and `1`.


## Related

* [brightness-cli](https://github.com/kevva/brightness-cli) - CLI for this module


## License

MIT © [Kevin Mårtensson](https://github.com/kevva)

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