extract-from-argv 0.0.1 → 0.0.2

package/README.md

@@ -1,11 +1,32 @@
 # extract-from-argv
 
-This library was generated with [Nx](https://nx.dev).
+## Usage
 
-## Building
+**Pass arguments to the node process and read it**
 
-Run `nx build extract-from-argv` to build the library.
+```node my-script.js --port=4200```
+```ts
+const port = extractFromArgv('--port'); // Returns '4200'
+```
 
-## Running unit tests
+**Custom separator**
 
-Run `nx test extract-from-argv` to execute the unit tests via [Jest](https://jestjs.io).
+```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,6 +1,6 @@
 {
   "name": "extract-from-argv",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "dependencies": {
     "tslib": "^2.3.0"
   },