# vulgar-fractions

Simple library to convert decimals into unicode vulgar fractions.

<div>
    <a href="https://www.npmjs.com/package/vulgar-fractions" target="_blank"><img src="https://badgen.net/npm/v/vulgar-fractions?cache=300" alt="NPM Version." /></a>
    <a href="https://www.npmjs.com/package/vulgar-fractions" target="_blank"><img src="https://badgen.net/npm/dw/vulgar-fractions" alt="NPM Downloads per week" /></a>
    <img src="https://badgen.net/npm/types/vulgar-fractions" alt="TypeScript types included." />
    <a href="https://bundlephobia.com/package/vulgar-fractions" target="_blank"><img src="https://badgen.net/bundlephobia/minzip/vulgar-fractions" alt="Bundlephobia minified + gzipped size." /></a>
    <a href="https://github.com/chanceaclark/vulgar-fractions/actions" target="_blank"><img src="https://badgen.net/github/checks/chanceaclark/vulgar-fractions" /></a>
</div>

## Usage

```ts
import { toDecimal, toVulgar } from 'vulgar-fractions';

// Convert decimal to unicode vulgar:
toVulgar(.25) // '¼'
toVulgar(1/9) // '⅑'

// Convert vulgar to decimal string:
toDecimal('⅛') // '0.125'
toDecimal('⅔') // '0.666...'
```

If a value doesn't have a "simple" conversion, meaning there is no appropriate unicode character, either function will return the stringified input.

```ts
toVulgar(.1274859937) // '.1274859937'
toDecimal('Hello World!') // 'Hello World!
```

### Parsing strings or multi-line text

```ts
parseVuglars('1/2 cup') // '½ cup'
parseVuglars('It take 1/2 cup chocolate chips and 1/4 cup sugar. Additionally it takes 4.75 cups flour.') // It take ½ cup chocolate chips and ¼ cup sugar. Additionally it takes 4 ¾ cups flour.
```

## Contribute

Feel free to open up a GitHub Issue, Discussion, or Pull Request.


Turn integers into vulgar unicode fractions and vice-versa. 

vulgar-fractions

Turn integers into vulgar unicode fractions and vice-versa.

vulgar-fractions

vulgar-fractions

Usage

Parsing strings or multi-line text

Contribute

Keywords