Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 1.64 KB

README.md

File metadata and controls

91 lines (63 loc) · 1.64 KB
Raw

card-type

Another module for card detection, with special attention for brazilian cards like Elo and Hipercard.

LIVE DEMO

supported cards

  • Visa
  • Mastercard
  • American Express
  • Diners Club
  • Discover
  • JCB
  • Maestro
  • UnionPay
  • Elo
  • Hipercard

installation

You can install it through NPM:

npm install @polvo-labs/card-type --save

Or you can just copy dist/card-type.js and include it into your project.

usage

// ES6
import { cardType, cards } from '@polvo-labs/card-type'

// CommonJS
var cardType = require('card-type').cardType
var cards = require('card-type').cards

// Global
var cardType = window.CardType.cardType
var cards = window.CardType.cards

NOTE: You don't need to import cards unless you want to extend it and include your own cards and patterns.

api

cardType (number) => String

The function that returns your card type.

cardType(4) // 'visa'
cardType('5143 5709 0399 4704') // 'mastercard'
cardType(384140) // 'hipercard'
cardType('00000') // ''

cards : Array

An array with card patterns and ranges. You can extend it and include your own cards.

cards.push({
  name: 'my-card',
  pattern: [
    777, // match every card that begins with `777`
    [8900, 8950] // match every card with range between 8900 and 8950
  ]
})

cardType('777') // 'my-card'
cardType(777123456789) // 'my-card'
cardType(8900) // 'my-card'
cardType('89250251') // 'my-card'

tests

Make sure to install all dependencies:

npm install

Then, just run:

npm test

contribution

Did you miss a card? Contributions are welcome!