https://github.com/plughacker/card-validator
A simple card validator
https://github.com/plughacker/card-validator
Last synced: 11 months ago
JSON representation
A simple card validator
- Host: GitHub
- URL: https://github.com/plughacker/card-validator
- Owner: plughacker
- License: mit
- Created: 2023-11-17T11:36:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T20:15:15.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T10:12:08.754Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 125 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
README
Card Validator
A simple card validator based on the Braintree validator
## Getting Started
1. Install the `card-validator` 💳
```bash
yarn add @malga/card-validator
# or
npm install @malga/card-validator
# or
pnpm add @malga/card-validator
```
2. Now just validate your cards
```ts
import { valid } from '@malga/card-validator'
valid.number('6274160007029307')
/*
{
card: {
niceType: 'VR',
type: 'vr',
patterns: [ 627416, 637036 ],
gaps: [],
lengths: [ 16 ],
code: { name: 'CVV', size: 3 },
matchStrength: 6
},
isPotentiallyValid: true,
isValid: true
}
*/
```
3. Mask a card number
```ts
import { maskCardNumber } from '@malga/card-validator'
maskCardNumber('0000000000000000')
// 0000 0000 0000 0000
```
## Contributing
Feel free to contribute to this project by submitting pull requests, creating documentation, or bringing ideas to make the project even better!