extract-from-argv 0.0.1 → 0.1.0

package/README.md

@@ -1,11 +1,34 @@
 # extract-from-argv
 
-This library was generated with [Nx](https://nx.dev).
+Extracts arguments that were passed when the Node.js process was launched.
 
-## Building
+## Usage
 
-Run `nx build extract-from-argv` to build the library.
+**Pass arguments to the node process and read it**
 
-## Running unit tests
+```node my-script.js --port=4200```
+```ts
+const port = extractFromArgv('--port'); // Returns '4200'
+```
 
-Run `nx test extract-from-argv` to execute the unit tests via [Jest](https://jestjs.io).
+**Custom separator**
+
+```node my-script.js --port:4200```
+```ts
+const port = extractFromArgv('--port', { valueSeparator: ':' }); // Returns '4200'
+```
+**Custom argv object**
+```ts
+const port = extractFromArgv('--port', { argv: ['/usr/node', '--port=5000'] }); // Returns '5000'
+```
+
+**Arguments without values**
+
+```node my-script.js --fun-mode```
+```ts
+// If an argument without an value is found it returns an empty string
+extractFromArgv('--fun-mode'); // Returns ''
+
+// If a argument was not found the function returns null
+extractFromArgv('--angry-mode'); // Returns null'
+```

package/package.json

@@ -1,10 +1,23 @@
 {
   "name": "extract-from-argv",
-  "version": "0.0.1",
+  "description": "Extracts arguments that were passed when the Node.js process was launched.",
+  "license": "MIT",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hansireit/angular-lib",
+    "directory": "libs/extract-from-argv"
+  },
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "type": "commonjs",
   "main": "./src/index.js",
-  "typings": "./src/index.d.ts"
+  "typings": "./src/index.d.ts",
+  "keywords": [
+    "node",
+    "argv",
+    "arguments",
+    "extract"
+  ]
 }