Permalink
Browse files

[docs] Generated some API doc's from the JSDoc

  • Loading branch information...
3rd-Eden committed Dec 1, 2012
1 parent fba32af commit 5d4e22044b5f05f59941badc7324592bb4ac2a2b
Showing with 66 additions and 0 deletions.
  1. +66 −0 docs/api.md
View
@@ -0,0 +1,66 @@
+
+
+<!-- Start lib/creditcard.js -->
+
+## mii
+
+Major Industry Identifier.
+
+The first digit of a ISO/IEC 7812 issuer identifier number (inn) tells about
+what industry the card is used. The index of the array should be the first
+number of the inn.
+
+## testnumbers
+
+Test numbers from different creditcard schemes. Most of them are taken from
+http://www.paypalobjects.com/en_US/vhelp/paypalmanager_help/credit_card_numbers.htm
+
+## cardscheme(number)
+
+Find out which major card scheme issued the card based on the iin range.
+
+### Params:
+
+* **String** *number*
+
+## format(number)
+
+Format the credit card number in to the same patterns as seen on the actual
+credit cards.
+
+### Params:
+
+* **String** *number*
+
+## validate(number)
+
+Validates the creditcards using the Luhn10 algorithm.
+
+### Params:
+
+* **String** *number*
+
+## pan
+
+Applies PAN truncation to the given creditcard. PAN (primary account number)
+trunction is a &quot;technology&quot; that prevents most of the digits of a creditcard
+from appearing on printed receipts.
+
+### Params:
+
+* **String** *number*
+
+### Return:
+
+* **String** pan
+
+## parse(number)
+
+Parse the creditcard information
+
+### Params:
+
+* **String** *number*
+
+<!-- End lib/creditcard.js -->
+

0 comments on commit 5d4e220

Please sign in to comment.