is-august
Version:
returns a 'true' boolean if date is august
74 lines (46 loc) • 2.35 kB
Markdown
# is-august [](https://www.npmjs.com/package/is-august) [](https://npmjs.org/package/is-august) [](https://npmjs.org/package/is-august) [](https://travis-ci.org/TJC-js/is-august)
> returns a 'true' boolean if date is august
Please consider following this project's author, [Tim Cane](https://github.com/timcane), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save is-august
```
## Usage
```js
var isAugust = require('is-august');
console.log(isAugust(new Date("2021-08-08"))); //=> true
console.log(isAugust(new Date("2021-02-02"))); //=> false
console.log(isAugust('not a date')); //=> false
```
## About
<details>
<summary><strong>Contributing</strong></summary>
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
</details>
<details>
<summary><strong>Running Tests</strong></summary>
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
</details>
<details>
<summary><strong>Building docs</strong></summary>
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
</details>
### Related projects
### Contributors
### Author
**Tim Cane**
+ [GitHub Profile](https://github.com/timcane)
+ [Twitter Profile](https://twitter.com/timcane)
### License
Copyright © 2021, [Tim Cane](https://github.com/timcane).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on January 15, 2021._