README.md

🇵🇹 Portuguese Utils

A set of usefull utils for developing Portuguese Web Applications.

🔰 How to install

Using NPM:

npm install --save portuguese-utils

Using Yarn:

yarn add portuguese-utils

🚀 How to use

CDN

You can use this lib in the browser using the minified bundle via CDN.

<script src="https://cdn.jsdelivr.net/npm/portuguese-utils@latest/portuguese-utils.min.js" />
<script>
    portugueseUtils.isValidPostalCode('3863-122')
</script>

Module

You can also use this package as a module following the instructions bellow

Import the needed function

• From the validators module

import { isValidPostalCode } from 'portuguese-utils/validators'

• From the single exported function

import isValidPostalCode from 'portuguese-utils/validators/isValidPostalCode'

• From the full package

import { isValidPostalCode } from 'portuguese-utils'

Using

const postalCode = '3863-122'
const isMyPostalCodeValid = isValidPostalCode(postalCode)
console.log(isMyPostalCodeValid) // true

📎 Documentation

Documentation is available at:

https://portuguese-utils.netlify.com/#/

License

MIT