https://github.com/keisukeyamashita/hyacinth

Light weight JavaScript library for star sign 🔮💫🔯
https://github.com/keisukeyamashita/hyacinth

javascript starsign typescript

Last synced: about 2 months ago
JSON representation

Light weight JavaScript library for star sign 🔮💫🔯

• Host: GitHub
• URL: https://github.com/keisukeyamashita/hyacinth
• Owner: KeisukeYamashita
• Created: 2019-10-15T06:56:00.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T21:45:45.000Z (about 2 months ago)
• Last Synced: 2024-10-29T23:48:22.722Z (about 2 months ago)
• Topics: javascript, starsign, typescript
• Language: TypeScript
• Homepage:
• Size: 270 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Hyacinth

[![CI](https://github.com/KeisukeYamashita/hyacinth/workflows/Test/badge.svg)](https://github.com/KeisukeYamashita/hyacinth/actions)

[![npm version](https://badge.fury.io/js/%40keisukeyamashita%2Fhyacinth.svg)](https://badge.fury.io/js/%40keisukeyamashita%2Fhyacinth)

![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)

![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)

> Light weight JavaScript library for star sign




    


    
Princess Hyacinth, Alfons Maria Mucha




## How to use

### Install

Install by these commands.

```

npm install @keisukeyamashita/hyacinth

```

or

```

yarn add @keisukeyamashita/hyacinth

```

### In your code

The sample is here.

```typescript

import hyacinth from '@keisukeyamashita/hyacinth'

import dayjs from 'dayjs'

const starsign = hyacinth(dayjs()).starSign();

console.log(starsign.name);

```

```terminal

$ ts-node index.ts

=> "魚座"

```

### Response

The response will be in this format.

```typescript

type SignStar interface {

    id: number

    name: string

    borderValue: number

}

```

## Support

* `dayjs` Object

* Native `Date` Object(not yet:<)

## Author

* [KeisukeYamashita](https://github.com/KeisukeYamashita)