preperations to be added to npm

Author: omidas

FA.md

@@ -0,0 +1 @@
+# کتابخانه پرداخت pay.ir برای typescript

README.md

@@ -1 +1 @@
-# payir-typescript
+# pay.ir node.js typescript library

lib/index.ts

@@ -12,12 +12,18 @@ interface IVerifyArguments {
   token: number;
 }
 
+/**
+ * this class proved all of your required functions to make a successful payment using pay.ir gateway
+ */
 export default class PayIrTypescript {
   private readonly API_KEY: string;
   private readonly sendEndPoint = 'https://pay.ir/pg/send';
   private readonly verifyEndPoint = 'https://pay.ir/pg/verify';
   private readonly gateway = 'https://pay.ir/pg/';
-
+  /**
+   * Creates an instance of pay ir typescript.
+   * @param api api code received from pay.ir
+   */
   constructor(api: string) {
     if (api === '' || typeof api !== 'string') {
       throw new Error(
@@ -26,7 +32,9 @@ export default class PayIrTypescript {
     }
     this.API_KEY = api;
   }
-
+  /**
+   * Handle errors of pay ir typescript
+   */
   private handleErrors = (reject: Function, error: any) => {
     if (error.response) {
       // The request was made and the server responded with a status code
@@ -46,7 +54,9 @@ export default class PayIrTypescript {
       );
     }
   };
-
+  /**
+   * get payment url
+   */
   public send = (args: ISendArguments, getRedirect: boolean = false) => {
     return new Promise((resolve, reject) => {
       if (typeof args.amount !== 'number' || args.amount < 1000) {
@@ -75,7 +85,9 @@ export default class PayIrTypescript {
         });
     });
   };
-
+  /**
+   * Verify successful  payment token
+   */
   public verify = (args: IVerifyArguments) => {
     return new Promise((resolve, reject) => {
       if (typeof args.token !== 'number') {

package.json

@@ -2,20 +2,40 @@
   "name": "pay-ir",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "build/lib/index.js",
+  "types": "build/lib/index.d.ts",
   "scripts": {
     "clean": "rimraf coverage build tmp",
     "build": "tsc -p tsconfig.release.json",
     "build:watch": "tsc -w -p tsconfig.release.json",
     "lint": "tslint -t stylish --project \"tsconfig.json\"",
     "server": "nodemon ./build/src/main.js"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "keywords": [
+    "typescript",
+    "payir"
+  ],
+  "author": "Omid Astaraki",
+  "license": "MIT",
   "dependencies": {
     "axios": "^0.18.0"
   },
+  "prepare": "npm run build",
+  "prepublishOnly": "npm run lint",
+  "preversion": "npm run lint",
+  "version": "git add -A src",
+  "postversion": "git push && git push --tags",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/electather/payir-typescript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/electather/payir-typescript/issues"
+  },
+  "homepage": "https://github.com/electather/payir-typescript",
+  "files": [
+    "lib/**/*"
+  ],
   "devDependencies": {
     "@types/axios": "^0.14.0",
     "typescript": "^3.4.3"