Skip to content

fix: Credit the original package, add usage etc. #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fireflysemantics merged 1 commit into from
Sep 4, 2026
Merged

fix: Credit the original package, add usage etc. #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ A typescript library of [validators and sanitizers](https://fireflysemantics.git

[![Build Status](https://travis-ci.org/fireflysemantics/validatorts.svg?branch=master)](https://travis-ci.org/fireflysemantics/validatorts)

## Credit

This project is a TypeScript rewrite based on the original [validator.js](https://github.com/validatorjs/validator.js) package, published on npm as [validator](https://www.npmjs.com/package/validator). The original package, its API, and its documentation remain the canonical reference.

## Typedoc

The [Typedoc](https://fireflysemantics.github.io/validatorts/) contains documentation for all the `validators` and `sanitizers`.
Expand All @@ -24,6 +28,18 @@ console.log(isPort('70000').value); //Logs false
console.log(isPort('4200').error); //Logs undefined
```

## Usage examples

```
// Validators
import { isEmail } from '@fireflysemantics/validatorts';
console.log(isEmail('test@example.com').value); // Logs true

// Sanitizers
import { escape } from '@fireflysemantics/validatorts';
console.log(escape('<b>').value); // Logs &lt;b&gt;
```

[Stackblitz Playground](https://stackblitz.com/edit/typescript-ezqnqa?file=index.ts)

## Error Handling
Expand Down