# get-the-moon

> 🌗 gets the Moon

Latest version **2.1.0** (published 2023-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-the-moon
pnpm add get-the-moon
yarn add get-the-moon
bun add get-the-moon
```

Provides the commands `moon`, `getMoon`, `getMoonAscii`, `getMoonEmoji`, `getMoonPercent`, `getMoonAgeInDays`.

## 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 | 2.1.0 |
| Published | 2023-02-08 |
| First published | 2020-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 468.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | ron |
| Maintainers | ronerlih |
| Keywords | moon, emoji, ascii, javascript |

## Links

- npm: https://www.npmjs.com/package/get-the-moon
- Repository: https://github.com/ronerlih/getTheMoon
- Homepage: https://github.com/ronerlih/getTheMoon#readme
- Issues: https://github.com/ronerlih/getTheMoon/issues
- npm.io page: https://npm.io/package/get-the-moon

## Recent versions

- 2.1.0 (latest) — 2023-02-08
- 2.0.1 — 2023-02-05
- 2.0.0 — 2023-02-05
- 1.1.0 — 2023-02-05
- 1.0.4 — 2023-02-05
- 1.0.3 — 2023-02-05
- 1.0.2 — 2023-02-05
- 1.0.0 — 2020-09-25
- 0.1.9 — 2020-09-25
- 0.1.8 — 2020-09-25
- 0.1.7 — 2020-09-25
- 0.1.6 — 2020-09-25
- 0.1.5 — 2020-09-24
- 0.1.4 — 2020-09-24
- 0.1.3 — 2020-09-24
- … 12 more at https://npm.io/package/get-the-moon/versions

## README

[![https://www.npmjs.com/package/get-the-moon](https://img.shields.io/npm/v/get-the-moon)](https://www.npmjs.com/package/get-the-moon)

# 🌔 Get The Moon!
###### (Example package for npm deployment)

##### And also, to get the current Moon phase in Javascript or the command line.

## Install
`npm i get-the-moon`

or globaly (to use in the command line)

`npm i get-the-moon -g`

## Usage

```js
const moon = require("get-the-moon");
console.log(moon.getMoonEmoji()) // 🌔 (according to the Moon phase)
```

## Methods

**moon.getMoonPercent** returns  \<*Number*> // floating point 
```js
console.log(Moon.getMoonPercent()) // 0.251490505183 (according to the Moon phase)
```

**moon.getMoonAgeInDays** returns  \<*Number*> // floating point 
```js
console.log(moon.getMoonAgeInDays()) // 7.4271304513887895 (according to the Moon phase)
```

**moon.getMoonEmoji** returns  \<*String*> // unicode emoji
```js
console.log(moon.getMoonEmoji()) // 🌔 (according to the Moon phase)
```

**getMoonAscii** returns  \<*String*> // and consoles the Ascii moon phase
```js
console.log(Moon.getMoonAscii([<Bool>])) // accepts an optional Boolean to inverse the Ascii background Characters (ASCII art according to the Moon phase)

// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmmdyyyssshhdNMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMMNNmdhhyss+/::::+shNMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmddhyyys+/-:---.-:ohNMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNdmddhys+///::::::--//+smMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNmddhhyo+//:/::/:::::-./smMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNmmddhyso++/////:::-:--.-+hNMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmmmddhhyso+++///////:-----..:yNMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmmddhhhyooo+o++/://///:/:--.'.:hNMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmddhhhhysssooo++/////:/::--.'.'./dMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmmdddhddsysssso++//:+/:::-:----.''.oNMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmdmmddhhdhyyyyyyo+/+////::..:----..''/mMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmNMMNNmdddhyyyyyoo+/:::/::----::-..'''-hMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNMMMMNNmmddyossso++/:::-::-------..''' .yMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMMMMMMMMNmdmdhsso++///::---:--:-.----.'  .yMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNmmmmmhyo+////:/:::::/:::::---.' '.hMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNmmddmdys++/////+///:/:++++///-.'''-mMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmNmddmdhsoooso//+//::/ooo+oooo:-'..-/NMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNmmddmmhyssyss++/:---:+ooooosoo-.--::hMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNMMNNNNNmmmdhyyyyhyo+/:-'-:oooosss::.'--+/NMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNddmmNmNmmmmdhhhhhyo///..-/+ooooo-.-..'--yMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNMMMNmmmMNNNmmddddddddyys+/-.--/+/:---:-.''-+MMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmdNMNMNmddmmddddhhyy+++/:-------/-+:.' ':NMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmmdmmMMNmmNmmddddhhhyoso++o//-----.::-'''./dMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmdddmNmmmNmmmddhhyyyyss+++osso+:::-/:.--'-/hMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmdddddmmNmNmdmdhhhhyyhyso+sosssssso/:/:-..'-:yMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmNdhhddddhmNmdddddho++soooosssssssso++::.-..'--hMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNmhhdhyhhhhhhddhdo++o++++ssssossoo+///---....-dMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNmmddhhyyososyhhyoo+++++++osssosoo+/:--.-.'''.mMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMNmmdddhyy+ssyhyyso+o+:://ooososso//-''.'.''''/NMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNdddddhhyy+ssysssso+++//::/+/oooo+/:-......'''yMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNmmmmdhhsy++o++ssooosso+/:-/+///+/+::--.-.'''-NMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMMNmNmddhysyoo/+/o+oosssoo/:::/::-://:-::.-.'''hMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNNmddhhyso+/+/:+ossssss::/+::////:--:--.'''+MMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNmdhdhhhyo++o::/+ooosss/////:/+/-''.-...'':mMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNNmddhdyyoo+o/////o++//+/:::--:-..'....''.dMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNMNmdhhyyysoo/+://+///://:---.....'''''.'.hMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMMNNmmhhhhsyoo+://///:/://::-..'''''''''..-hMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNmMmmmhdhhhhyo+o++//:////:::::.' '  '''''./mMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmmmmmddddhyyos+++++/+//::-:--.''' ..''..oNMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMMmmmmddhydssoo+o+++++//::----.'''...../hMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmNmNdhhhhyssooo++///:/::---.--------omMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNmmmdddhhssoo++++//::::---:------:+dMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNdNmmdyhdsyooo+++/::--:--::----:odNMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNdmddhdhyyoo++///::--::----:/smMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNhNhmyhhshoo/+///:::/::-::+hNMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNNmmdddhhyss++++///:-:-:+ymMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMmmmhdhyyso++//::::/sdNMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMmNmdhyyss+////+ydNMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNMmhysyyyhdmNMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
// MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMNNMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM

```

#### ASCII tools shoutouts 💎
- web: https://www.text-image.com/convert/ascii.html
- npm: https://www.npmjs.com/package/asciify-image
- npm https://www.npmjs.com/package/image-to-ascii
#### Command Line Methods
```sh
$ moon [-inverse] (getMoonAscii) //return <String> and prints the Ascii Moon
```
```sh
$ getMoon [-inverse] (getMoonAscii) //return <String> and prints the Ascii Moon
```
```sh
$ getMoonAscii [-inverse] //return <String> and prints the Ascii Moon
```
```sh
$ getMoonEmoji //return <String> Moon emoji acording to moon phase 
```
```sh
$ getMoonPercent // returns <Number> floating point acording to moon phase
```
```sh
$ getMoonAgeInDays // returns <Number> floating point acording to moon phase
```

## 🌼 Contributing

Contributions are welcome!! 
- Issues with Feature requests, ideas ✨ and Bug reports 🐞 are welcome!
- Or Fork & Pull request.

## License
get-the-moon is distributed under The [MIT License](https://opensource.org/licenses/MIT)

## ❤️ Many thanks to
https://www.subsystems.us/uploads/9/8/9/4/98948044/moonphase.pdf
http://bazaar.launchpad.net/~keturn/py-moon-phase/trunk/annotate/head:/moon.py
https://astronomy.stackexchange.com/questions/20973/what-should-i-consider-in-order-to-accurately-calculate-the-moon-phase
https://en.wikipedia.org/wiki/Jean_Meeus

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