logical-not/README.md

Logical NOT Function

# Logical NOT Function

The **not** function is an alphabetic analogue of the unary operator **!**.
It is used to increase the readability of the code.

Usage:

```js
import not from "logical-not";
// or import { not } from "logical-not";

if (not("foo".includes("bar"))) {
    console.log("baz");
}
```

### Typescript support

```ts
function main(): void {
    const div = document.querySelector("div");
    // div is HTMLDivElement | null

    if (not(div)) return;
    // now div is HTMLDivElement

    div.textContent; // ok
    // ^ no 'possibly null' error
}
```

## License

MIT License (see `LICENSE` file).