# lun-phase

> ask me about lunation

Latest version **0.1.1** (published 2015-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install lun-phase
pnpm add lun-phase
yarn add lun-phase
bun add lun-phase
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-02-25 |
| First published | 2015-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | olivia haas |
| Maintainers | livhaas |
| Keywords | moon, lunation, lunar, phase |

## Links

- npm: https://www.npmjs.com/package/lun-phase
- Repository: https://github.com/livhaas/lun-phase
- Issues: https://github.com/livhaas/lun-phase/issues
- npm.io page: https://npm.io/package/lun-phase

## Dependencies (1)

- [node-emoji](https://npm.io/package/node-emoji.md) ^0.1.0

## Recent versions

- 0.1.1 (latest) — 2015-02-25
- 0.1.0 — 2015-02-25

## README

# lun-phase

You may receive:
1. A numerical value representing the moon's age in the current lunation
2. A numerical value representing the moon's phase
3. An emoji representing the moon's phase
4. The name of the current phase as a string


## Usage

```
  var Lun = require("lun-phase");
  var lun = new Lun();

  console.log(lun.now());
```
will return an object that looks something like this
Your values will likely be different based on what day it is.

```
  {
    age: 6,
    phase: 2,
    emoji: ':first_quarter_moon:',
    name: 'First Quarter Moon'
  }
```

## Notes

We deal in whole numbers because this is a wholly unscientific endeavor.

Thank you Ben Daglish for providing moon phase calculation methods.
- http://www.ben-daglish.net/moon.shtml

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