https://github.com/lemoncode/fonk-negative-number-validator
Negative number validator for https://github.com/Lemoncode/fonk
https://github.com/lemoncode/fonk-negative-number-validator
Last synced: about 1 year ago
JSON representation
Negative number validator for https://github.com/Lemoncode/fonk
- Host: GitHub
- URL: https://github.com/lemoncode/fonk-negative-number-validator
- Owner: Lemoncode
- License: mit
- Created: 2019-09-11T14:28:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-07T09:07:15.000Z (over 6 years ago)
- Last Synced: 2025-05-08T01:43:28.446Z (about 1 year ago)
- Language: TypeScript
- Size: 27.3 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fonk-negative-number-validator
[](https://circleci.com/gh/Lemoncode/fonk-negative-number-validator/tree/master)
[](https://www.npmjs.com/package/@lemoncode/fonk-negative-number-validator)
[](https://bundlephobia.com/result?p=@lemoncode/fonk-negative-number-validator)
This is a [fonk](https://github.com/Lemoncode/fonk) microlibrary that brings validation capabilities to:
- Validate if a field of a form is a negative number
How to install it:
```bash
npm install @lemoncode/fonk-negative-number-validator --save
```
How to add it to an existing form validation schema:
We have the following form model:
```
const myFormValues = {
product: 'shoes',
price: 20,
}
```
We can add a negativeNumber validation to the myFormValues
```javascript
import { negativeNumber } from '@lemoncode/fonk-negative-number-validator';
const validationSchema = {
field: {
price: [negativeNumber.validator],
},
};
```
The validator must be configured with the following required arguments:
```javascript
export interface CustomValidatorArgs {
strictTypes?: boolean;
allowZero?: boolean;
}
```
These are the default arguments:
```javascript
let defaultCustomArgs: CustomValidatorArgs = {
strictTypes: false,
allowZero: false,
};
```
You can specify the custom arguments in two ways:
- Locally just customize the arguments for this validationSchema (e.g. We can specify if the validator allows zero):
```javascript
import { negativeNumber } from '@lemoncode/fonk-negative-number-validator';
const validationSchema = {
field: {
price: [
{
validator: negativeNumber.validator,
customArgs: { allowZero: true },
},
],
},
};
```
- Globally, replace the default custom arguments in all validationSchemas (e.g. enable strict types):
```javascript
import { negativeNumber } from '@lemoncode/fonk-negative-number-validator';
negativeNumber.setCustomArgs({ strictTypes: true });
```
You can customize the error message displayed in two ways:
- Globally, replace the default error message in all validationSchemas (e.g. porting to spanish):
```javascript
import { negativeNumber } from '@lemoncode/fonk-negative-number-validator';
negativeNumber.setErrorMessage('El campo debe de ser un número negativo');
```
- Locally just override the error message for this validationSchema:
```javascript
import { negativeNumber } from '@lemoncode/fonk-negative-number-validator';
const validationSchema = {
field: {
price: [
{
validator: negativeNumber.validator,
message: 'Error message only updated for the validation schema',
},
],
},
};
```
Please, refer to [fonk](https://github.com/Lemoncode/fonk) to know more.
## License
[MIT](./LICENSE)
# About Basefactor + Lemoncode
We are an innovating team of Javascript experts, passionate about turning your ideas into robust products.
[Basefactor, consultancy by Lemoncode](http://www.basefactor.com) provides consultancy and coaching services.
[Lemoncode](http://lemoncode.net/services/en/#en-home) provides training services.
For the LATAM/Spanish audience we are running an Online Front End Master degree, more info: http://lemoncode.net/master-frontend