Merge pull request #4 from ozgurg/dev

release: v1.1.0

.eslintignore

@@ -0,0 +1 @@
+*.ts

.eslintrc.json

@@ -12,6 +12,7 @@
     "sourceType": "module"
   },
   "rules": {
+    "require-jsdoc": "off",
     "quotes": [
       "error",
       "double"

README.md

@@ -56,12 +56,12 @@ padCenter({
 
 All options are required.
 
-| Option    | Type                        |
-|-----------|-----------------------------|
-| startWith | `string | number`      |
-| endWith   | `string | number`      |
-| fillWith  | `string | number`      |
-| length    | `number` (positive integer) |
+| Option    | Type                                   |
+|-----------|----------------------------------------|
+| startWith | <code>string &#124; number</code>      |
+| endWith   | <code>string &#124; number</code>      |
+| fillWith  | <code>string &#124; number</code>      |
+| length    | <code>number</code> (positive integer) |
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "pad-center",
-    "version": "1.0.1",
+    "version": "1.1.0",
     "description": "pad-center fills between start and end characters with whatever character you want while keeping the length constant.",
     "license": "MIT",
     "type": "module",
@@ -15,26 +15,31 @@
         "lint:fix": "npm run lint -- --fix",
         "lint": "eslint --ext .js .",
         "lint-staged": "lint-staged",
+        "generate-types": "tsc",
         "prepare": "husky install"
     },
     "author": {
         "email": "ozgurgorgulu54@gmail.com",
         "name": "Özgür Görgülü",
         "url": "https://github.com/ozgurg"
     },
+    "types": "./src/types/pad-center.d.ts",
     "keywords": [
         "pad-center",
         "pad",
         "pad-middle",
-        "string"
+        "barcode",
+        "generator",
+        "masking"
     ],
     "devDependencies": {
         "@types/jest": "^28.1.4",
         "eslint": "^8.18.0",
         "eslint-config-google": "^0.14.0",
         "husky": "^8.0.1",
         "jest": "^28.1.2",
-        "lint-staged": "^13.0.3"
+        "lint-staged": "^13.0.3",
+        "typescript": "^4.7.4"
     },
     "lint-staged": {
         "*.js": [

src/types/pad-center.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @param {{startWith: (string|number), endWith: (string|number), fillWith: (string|number), length: number}} options
+ * @return {string}
+ */
+export function padCenter(options: {
+    startWith: (string | number);
+    endWith: (string | number);
+    fillWith: (string | number);
+    length: number;
+}): string;

tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "include": [
+        "./src/*js"
+    ],
+    "exclude": [
+        "./src/*.test.js"
+    ],
+    "compilerOptions": {
+        "outDir": "./src/types",
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "allowJs": true
+    }
+}