https://github.com/marcmarine/western-signs

Explore topics related to the western world.
https://github.com/marcmarine/western-signs

astrology horoscope western-signs zodiac

Last synced: 4 months ago
JSON representation

Explore topics related to the western world.

• Host: GitHub
• URL: https://github.com/marcmarine/western-signs
• Owner: marcmarine
• License: mit
• Created: 2024-07-21T09:42:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-18T10:38:44.000Z (11 months ago)
• Last Synced: 2025-02-21T05:18:00.353Z (9 months ago)
• Topics: astrology, horoscope, western-signs, zodiac
• Language: TypeScript
• Homepage: https://www.npmjs.com/western-signs
• Size: 2.36 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Western Signs

Simple interface for [western astrological](https://en.wikipedia.org/wiki/Western_astrology) signs.

[![NPM Version](https://img.shields.io/npm/v/western-signs)](https://www.npmjs.com/package/western-signs)

[![GitHub License](https://img.shields.io/github/license/marcmarine/western-signs)](LICENSE)

[![View Changelog](https://img.shields.io/badge/view-CHANGELOG.md-red.svg)](https://github.com/marcmarine/western-signs/releases)

[![TypeDoc](https://img.shields.io/badge/view-docs-yellow.svg)](https://marcmarine.github.io/western-signs)

![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/western-signs)

The **Western Signs** library provides detailed information about each astrological sign, including its `name`, `element`, `modality`, `rulingPlanet` and `glyph`, among other things. Additionally, you can specify the language for translations.

WordArt

![West Art](https://github.com/marcmarine/western-signs/raw/main/WestArt.gif)

## Installation

To install dependencies:

```bash

npm install western-signs

```

## Usage

To use the `getSignByName` function, import it along with the `SIGNS` constant from the `western-signs` package:

```js

import { getSignByName, SIGNS } from 'western-signs'

```

Call the function with the desired astrological sign and optionally specify a language code. If no language code is provided, it defaults to English.

```js

const data = getSignByName(SIGNS.TAURUS)

```

It should returns an object with the following properties:

```js

{

  bodyPart: 'Throat',

  character: 'Bull',

  element: 'Earth',

  endDate: 2020-05-20T22:00:00.000Z,

  glyph: '♉',

  modality: 'Fixed',

  name: 'Taurus',

  number: 2,

  pole: 'Negative',

  rulingPlanet: 'Venus',

  season: 'Spring',

  startDate: 2020-04-20T22:00:00.000Z

}

```

## API Reference

### Functions

- [getHouses](https://marcmarine.github.io/western-signs/functions/getHouses)

- [getSignByDate](https://marcmarine.github.io/western-signs/functions/getSignByDate)

- [getSignByName](https://marcmarine.github.io/western-signs/functions/getSignByName)

- [getSigns](https://marcmarine.github.io/western-signs/functions/getSigns)

### Interfaces

- [House](https://marcmarine.github.io/western-signs/interfaces/House)

- [Sign](https://marcmarine.github.io/western-signs/interfaces/Sign)

For more detailed API information, please check out the [documentation](https://marcmarine.github.io/western-signs).

## License

MIT License © 2024 [Marc Mariné](https://github.com/marcmarine)