Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anthgrim/general-formatter
general-formatter
https://github.com/anthgrim/general-formatter
currency-formatter dateformatter npm npm-module npm-package package
Last synced: 6 days ago
JSON representation
general-formatter
- Host: GitHub
- URL: https://github.com/anthgrim/general-formatter
- Owner: anthgrim
- Created: 2022-10-14T19:51:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-26T00:41:57.000Z (almost 2 years ago)
- Last Synced: 2024-04-28T10:42:06.378Z (8 months ago)
- Topics: currency-formatter, dateformatter, npm, npm-module, npm-package, package
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/general-formatter
- Size: 23.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# general-formatter
## [general-formatter](https://www.npmjs.com/package/general-formatter)
## Description
This is a small npm package, with a few functions that I use very often. I got tired of having to code it many different projects :)
The functions a very straightforward. I'm using the `Intl` object from JavaScript that provides language sensitive string comparison, number formatting, and date-time formatting. Check the official MDN docs here [JS Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl)
### Disclaimer
This is my first ever npm package, so if you have any suggestions or a better solution you are more than welcome to contribute to this project. Or if you want to keep adding more formatting or format validation functions :). But please let's keep it simple.
## Installation
Fork this repository, and follow the git commands bellow:
```
cd
npm i general-formatter
```
## How to use?
general-formatter uses ES6 so you need to use imports :)
```JavaScript
import {convertToMoneyString, convertToDateString, validateEmailFormat} from "general-formatter"
```
## Sample Functions
### convertToMoneyString
This function takes a number amount, string country code, the style you want the number to be returned to, and the currency code
```JavaScript
const myMoneyString = convertToMoneyString(29.465654023, "en-US", "currency", "USD")
console.log(myMoneyString) // Logs $29.47
```
### convertToDateString
This function takes a date-like string, and a country code string referring to the country date format you want your date to be returned.
```JavaScript
const myDateString = convertToDateString("2022-10-10T22:11:02.024+00:00", "en-US")
console.log(myDateString) // Logs 10/10/2022
```
### validateEmailFormat
This function takes an string, and uses regex to validate if the string has a valid email format.
```JavaScript
const isValidEmail = validateEmailFormat("johndoe")
console.log(isValidEmail) // Logs false
```
## How to contribute
- Fork this repository
- Follow the git commands in your favorite terminal
```bash
git clone [email protected]:/formatter-npm-package.git
cd formatter-npm-package
git checkout -b
```
- After adding your changes please commit the new branch and open a PR
```bash
git add
git commit -m
git push origin
```
- Pull Request in GitHub [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)