# @platformbuilders/validations

> Validações de comuns de formulários

Latest version **0.1.6** (published 2023-09-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install @platformbuilders/validations
pnpm add @platformbuilders/validations
yarn add @platformbuilders/validations
bun add @platformbuilders/validations
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2023-09-12 |
| First published | 2020-11-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 953.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Platform Builders |
| Maintainers | luancteixeira, dev-builders |
| Keywords | platformbuilders, builders, validations |

## Links

- npm: https://www.npmjs.com/package/@platformbuilders/validations
- Repository: https://github.com/platformbuilders/validations
- Homepage: https://github.com/platformbuilders/validations#readme
- Issues: https://github.com/platformbuilders/validations/issues
- npm.io page: https://npm.io/package/@platformbuilders/validations

## Dependencies (1)

- [styled-components](https://npm.io/package/styled-components.md) ^6.0.7

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.6 (latest) — 2023-09-12
- 0.1.5 — 2023-06-26
- 0.1.4 — 2023-06-11
- 0.1.3 — 2023-05-30
- 0.1.2 — 2023-04-17
- 0.1.1 — 2023-02-10
- 0.0.20 — 2022-11-28
- 0.0.19 — 2021-10-22
- 0.0.18 — 2021-10-16
- 0.0.17 — 2021-10-01
- 0.0.16 — 2021-10-01
- 0.0.15 — 2021-08-23
- 0.0.13 — 2021-07-13
- 0.0.12 — 2021-07-07
- 0.0.11 — 2021-07-05
- … 10 more at https://npm.io/package/@platformbuilders/validations/versions

## README

# Welcome to Platform Builders `Validations`

[![Build Status][check-badge]][workflows]
[![codecov][codecov]](https://codecov.io/gh/platformbuilders/validations)
[![npm][npm-badge]][npm]
[![MIT][license-badge]][license]

[npm-badge]: https://img.shields.io/npm/v/@platformbuilders/validations.svg
[npm]: https://www.npmjs.com/package/@platformbuilders/validations
[license-badge]: https://img.shields.io/dub/l/vibe-d.svg
[license]: https://raw.githubusercontent.com/platformbuilders/validations/master/LICENSE.md
[workflows]: https://github.com/platformbuilders/validations/actions
[check-badge]: https://github.com/platformbuilders/validations/workflows/check/badge.svg
[codecov]: https://codecov.io/gh/platformbuilders/validations/branch/master/graph/badge.svg

Welcome to the Platform Builder form `validations` package here you will find out all the helpers that we use on our projects

# Whats the idea of this repository

Easily apply validations to forms, specially using [yup](https://github.com/jquense/yup).

# How can i use the library?

Just add the library to your project and import it!

1. Depend on it:

```
yarn add @platformbuilders/validations
```

3. Import example:

```
import { isValidFullName } from '@platformbuilders/validations'

```

# Validations

| Name                                                         | Returns         | Arguments         |
| ------------------------------------------------------------ | --------------- | ----------------- |
| [`isValidAccountBank`](./docs/isValidAccountBank.md)         | truthy OR falsy | (string)          |
| [`isValidAlphabetLetters`](./docs/isValidAlphabetLetters.md) | truthy OR falsy | (string)          |
| [`isValidAlphanumeric`](./docs/isValidAlphanumeric.md)       | truthy OR falsy | (string)          |
| [`isValidBirthDate`](./docs/isValidBirthDate.md)             | truthy OR falsy | (string)          |
| [`isValidCep`](./docs/isValidCep.md)                         | truthy OR falsy | (string)          |
| [`isValidCnpj`](./docs/isValidCnpj.md)                       | truthy OR falsy | (string)          |
| [`isValidCpf`](./docs/isValidCpf.md)                         | truthy OR falsy | (string)          |
| [`isValidCurrency`](./docs/isValidCurrency.md)               | truthy OR falsy | (string)          |
| [`isValidDDD`](./docs/isValidDDD.md)                         | truthy OR falsy | (string)          |
| [`isValidDocument`](./docs/isValidDocument.md)               | truthy OR falsy | (string)          |
| [`isValidDocumentDate`](./docs/isValidDocumentDate.md)       | truthy OR falsy | (string)          |
| [`isValidEmail`](./docs/isValidEmail.md)                     | truthy OR falsy | (string)          |
| [`isValidFullName`](./docs/isValidFullName.md)               | truthy OR falsy | (string)          |
| [`isValidOnlyNumbers`](./docs/isValidOnlyNumbers.md)         | truthy OR falsy | (string)          |
| [`isValidPassword`](./docs/isValidPassword.md)               | truthy OR falsy | (string)          |
| [`isValidPhone`](./docs/isValidPhone.md)                     | truthy OR falsy | (string, number?) |
| [`isValidPin`](./docs/isValidPin.md)                         | truthy OR falsy | (string, number?) |
| [`isValidPositiveValue`](./docs/isValidPositiveValue.md)     | truthy OR falsy | (string)          |
| [`isValidSocialName`](./docs/isValidSocialName.md)           | truthy OR falsy | (string)          |
| [`isValidNickName`](./docs/isValidNickName.md)               | truthy OR falsy | (string)          |
| [`isValidSocialUsername`](./docs/isValidSocialUsername.md)   | truthy OR falsy | (string)          |

---
_Source: https://npm.io/package/@platformbuilders/validations · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
