# js-string-validator

> JS String validator utility class

Latest version **2.0.0** (published 2020-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install js-string-validator
pnpm add js-string-validator
yarn add js-string-validator
bun add js-string-validator
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-05-16 |
| First published | 2020-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Theekshana Wijesinghe |
| Maintainers | theekshanawj |
| Keywords | JS, String, Validator |

## Links

- npm: https://www.npmjs.com/package/js-string-validator
- Repository: https://github.com/theekshanawj/js-string-validator
- Homepage: https://github.com/theekshanawj/js-string-validator#readme
- Issues: https://github.com/theekshanawj/js-string-validator/issues
- npm.io page: https://npm.io/package/js-string-validator

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-05-16
- 1.1.0 — 2020-03-30
- 1.0.0 — 2020-03-24

## README

# js-string-validator

![Script Validator](https://github.com/theekshanawj/js-string-validator/workflows/Script%20Validator/badge.svg?branch=master&event=push)

JavaScript String validator utility class.
Based on the builder pattern, this class will all you to validate the given string for user defined criteria.

## Add to your application 

Get the package from [here](https://www.npmjs.com/package/js-string-validator)
```
npm i js-string-validator
```

## How to use

- ### Basic usage
```
const StringValidator = require('js-string-validator');
  
let validator = new StringValidator('some string');

let isValidString = validator.min(0).max(20).regex(/\s+/).includes('string').validate();

console.log(isValidString);
// true -> string obey all criteria

console.log(validator.validate());
// true -> valid string without any criteria

validator = new StringValidator();

console.log(validator.validate());
// false -> Not a valid string
```

- ### Builder 

Create a template (validator function) for re-usability

```javascript
const StringValidatorBuilder = require('js-string-validator/builder');
  
const validator = StringValidatorBuilder().min(0).max(20).regex(/\s+/).includes('string').build();

console.log(validator('some string'));
// true  -> string obeys the pattern

console.log(validator('random'));
// false -> string violates the pattern

console.log(validator());
// false -> undefined not allowed
```


## API specification

- ### Basic usage

Following methods can be linked to validate a given string

| Method | Definition |Usage | Example |
|---|---|---|---|
|constructor| `new StringValidator(value) ; value: string \| null \| undefined` | Initialize the validator with `value` to be validated. | `new StringValidator()`|
| length | `length(number) ; number : any` | Validate the length of the string. Validation is skipped if `number` not 0 or +. |  `validator.length(1).validate()`|
| max | `max(number) ; number : any` | Validate the max length of the string. Validation is skipped if `number` is not 0 or +. | `validator.max(10).validate()`|
| min | `min(number) ; number : any` | Validate the min length of the string. Validation is skipped if `number` is not 0 or +. | `validator.min(0).validate()`|
| regex | `regex(regexPattern) ; regexPattern : any` | Validate for the string for given `regexPattern`. Validation is skipped if the pattern is not a regex | `validator.regex(/[0-9a-zA-Z]+/).validate()`|
| includes | `includes(subString) ; subString: any` |  Validate if `subString` includes in the string. Validation is skipped if the `subString` is undefined | `validator.includes('test').validate()`|
| allow | `allow(allowedValue) ; allowedValue: any` | Validate `true` if constructed with `allowedValue`| `validator.allow(undefined).validate()`|
| validate | `validate()` | Validate the given string with given criteria | `validator.max(10).min(0).validate()`|

- ### Builder

Builder API will allow creation of a template for String validation.

`length, max, regex, includes, allow` can be used to build a template (combine these methods in any form suits).

Use `build()` to generate a validator function.

```javascript
StringValidatorBuilder().length(number).max(number).min(number).regex(regexPattern).includes(subString).allow(allowedValue).build();
```

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