pingman 2.1.0 → 2.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Govind S
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Govind S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,204 +1,211 @@
-# PINGMAN [![build](https://github.com/dopecodez/pingman/workflows/build/badge.svg)](https://github.com/dopecodez/pingman/actions) [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dopecodez/pingman/issues) [![npm version](https://badge.fury.io/js/pingman.svg)](https://badge.fury.io/js/pingman) [![Test Coverage](https://codecov.io/github/dopecodez/pingman/graph/badge.svg?token=KRY7AENTQE)](https://codecov.io/github/dopecodez/pingman)
-
-Human-friendly node wrapper for ping utility across platforms.
-
-Add ping utility to your projects with zero dependencies. Build with latest ES6 features with native support for async/await and promises.
-
-Newly released and actively maintained. Small unpacked size.
-
-# INSTALLATION
-
-```
-$ npm install pingman
-```
-
-## Highlights
-
-- [Usage](#Usage)
-- [Available options](#available-options)
-- [Output Model](#output-model)
-- [Types](#types)
-- [Extended options(Platform-specific)](#extended-options)
-- [Contributing](#contributing)
-
-## Usage
-
-```js
-const ping = require('pingman');
-
-(async () => {
-	try {
-		const response = await ping('127.0.0.1');
-		console.log(response);
-		if(response.alive){
-		//=>if pinged ip is available and responds
-		}	
-	} catch (error) {
-		console.log(error);
-		//=> 'Internal server error ...'
-	}
-})();
-```
-
-### Usage with options and TypeScript
-
-```js
-import ping, {pingResponse, pingOptions} from 'pingman'
-
-(async () => {
-	try {
-		const options: pingOptions = {logToFile:true, numberOfEchos: 6, timeout: 2, IPV4: true};
-		const response: pingResponse = await ping('www.github.com', {logToFile:true, numberOfEchos: 6, timeout: 2, IPV4: true});
-		console.log(response);
-		if(response.alive){
-		//=>if pinged ip is available and responds
-		}
-	} catch (error) {
-		console.log(error);
-		//=> 'Internal server error ...'
-	}
-})();
-```
-
-## Available options
-
-```js
-let response = await ping(TargetIp, {options})
-```
-`TargetIp` can be any valid IPV4 host, IPV6 host or domain name.
-
-The `options` available are based on the docs available for [Windows](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/ping), and the `man` pages for [Mac](https://ss64.com/osx/ping.html) and [Linux](https://linux.die.net/man/8/ping).
-
-There are options which are platform-specific across all three platforms. These are included in the `extendedPingOptions` available and can be found [here](#extended-options). The general options available are abstracted across platforms and should work on all platforms. They can be found in the `pingOptions` object available in types.
-
-| option         | Type        | On Windows    | On Unix          |
-| :---           |    :----:   | :---          | :----            |
-| numeric        | boolean     | -a            | -n               |
-| bufferSize     | number      | -l            | -s               |
-| numberOfEchos  | number      | -n            | -c               |
-| TTL            | number      | -i            | -t(-m for Mac)   |
-| timeout        | number      | -w            | -w(-W for Mac)   |
-| IPV6           | boolean     | -6            | ping6            |
-| IPV4           | boolean     | -4            | ping             |
-
-**Note : The above options are the general options across platforms**
-
-Please specify the `IPV6` option in case the target is an IPV6 address. While in windows it is not required, it is required in unix systems so as to invoke `ping6` command.
-
-There are two further options available: `logToFile` and `logFilePath`. If `logToFile` is set to true, it will log the command and output to a default `log.txt` file at your project root. This is helpful in case you are trying to debug or want a more detailed idea of the output. `logFilePath` can be used in case you want a custom log file path relative to your project root.
-
-## Output Model
-
-```js
-/**
- * Parsed response
- * @typedef {pingResponse} pingResponse
- * @param {string} host - The input IP address or HOST
- * @param {string} numeric_host - Target IP address
- * @param {boolean} alive - True for existed host
- * @param {string} output - Raw stdout from system ping
- * @param {number} time - Time (float) in ms for first successful ping response
- * @param {Array<number>} times - Array of Time (float) in ms for each ping response
- * @param {number} min - Minimum time for collection records
- * @param {number} max - Maximum time for collection records
- * @param {number} avg - Average time for collection records
- * @param {number} bufferSize - Buffer size of each packet sent to target
- * @param {string} packetLoss - Packet Losses in percent (100% -> "100.000")
- * @param {string} number - Standard deviation time for collected records
- */
-```
-
-## Types
-
-Pingman exports some handy TypeScript types and interfaces. See the type definition for all the exported types.
-
-## Extended options
-
-**Note : Using the below options could cause your code to behave unexpectedly in some platforms**
-
-| option          | Type        | On Windows    | On Unix          |
-| :---            |    :----:   | :---          | :----            |
-| recordRouteHops | number      | -r            | N/A              |
-| hopTimestamp    | number      | -s            | N/A              |
-| interval        | number      | N/A           | -i               |
-| soDebugOption   | boolean     | N/A           | -d               |
-| floodPing       | boolean     | N/A           | -f               |
-| interfaceAddress| string      | N/A           | -I               |
-| suppressLoopback| boolean     | N/A           | -L               |
-| pattern         | string      | N/A           | -p               |
-| quiet           | boolean     | N/A           | -q               |
-| timeBeforeExit  | number      | N/A           | -W(-t for Mac)   |
-| verboseOutput   | boolean     | N/A           | -v               |
-| doNotFragment   | boolean     | -f            | -D for Mac       |
-| srcAddr         | string      | -S            | -S for Mac       |
-
-## Contributing
-
-Before opening a pull request please make sure your changes follow the
-[contribution guidelines][1].
-
-[1]: https://github.com/dopecodez/pingman/blob/master/CONTRIBUTING.md
-
-## Contributors
-
-The project would not be the way it is without these rockstars.
-
-<!-- readme: contributors -start -->
-<table>
-	<tbody>
-		<tr>
-            <td align="center">
-                <a href="https://github.com/dopecodez">
-                    <img src="https://avatars.githubusercontent.com/u/34269105?v=4" width="100;" alt="dopecodez"/>
-                    <br />
-                    <sub><b>Govind S</b></sub>
-                </a>
-            </td>
-            <td align="center">
-                <a href="https://github.com/Greeshmareji">
-                    <img src="https://avatars.githubusercontent.com/u/57181018?v=4" width="100;" alt="Greeshmareji"/>
-                    <br />
-                    <sub><b>Greeshma R</b></sub>
-                </a>
-            </td>
-            <td align="center">
-                <a href="https://github.com/luludotdev">
-                    <img src="https://avatars.githubusercontent.com/u/2358182?v=4" width="100;" alt="luludotdev"/>
-                    <br />
-                    <sub><b>Lulu</b></sub>
-                </a>
-            </td>
-            <td align="center">
-                <a href="https://github.com/JesseVermeulen123">
-                    <img src="https://avatars.githubusercontent.com/u/43927190?v=4" width="100;" alt="JesseVermeulen123"/>
-                    <br />
-                    <sub><b>JessC) Vermeulen</b></sub>
-                </a>
-            </td>
-            <td align="center">
-                <a href="https://github.com/Sahilhawal">
-                    <img src="https://avatars.githubusercontent.com/u/50511333?v=4" width="100;" alt="Sahilhawal"/>
-                    <br />
-                    <sub><b>Sahil Hawal</b></sub>
-                </a>
-            </td>
-            <td align="center">
-                <a href="https://github.com/chebro">
-                    <img src="https://avatars.githubusercontent.com/u/54331348?v=4" width="100;" alt="chebro"/>
-                    <br />
-                    <sub><b>Sravanth C.</b></sub>
-                </a>
-            </td>
-		</tr>
-		<tr>
-            <td align="center">
-                <a href="https://github.com/foxxyz">
-                    <img src="https://avatars.githubusercontent.com/u/2602605?v=4" width="100;" alt="foxxyz"/>
-                    <br />
-                    <sub><b>Foxxyz</b></sub>
-                </a>
-            </td>
-		</tr>
-	<tbody>
-</table>
-<!-- readme: contributors -end -->
+# PINGMAN [![build](https://github.com/dopecodez/pingman/workflows/build/badge.svg)](https://github.com/dopecodez/pingman/actions) [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dopecodez/pingman/issues) [![npm version](https://badge.fury.io/js/pingman.svg)](https://badge.fury.io/js/pingman) [![Test Coverage](https://codecov.io/github/dopecodez/pingman/graph/badge.svg?token=KRY7AENTQE)](https://codecov.io/github/dopecodez/pingman)
+
+Human-friendly node wrapper for ping utility across platforms.
+
+Add ping utility to your projects with zero dependencies. Build with latest ES6 features with native support for async/await and promises.
+
+Newly released and actively maintained. Small unpacked size.
+
+# INSTALLATION
+
+```
+$ npm install pingman
+```
+
+## Highlights
+
+- [Usage](#Usage)
+- [Available options](#available-options)
+- [Output Model](#output-model)
+- [Types](#types)
+- [Extended options(Platform-specific)](#extended-options)
+- [Contributing](#contributing)
+
+## Usage
+
+```js
+const ping = require('pingman');
+
+(async () => {
+	try {
+		const response = await ping('127.0.0.1');
+		console.log(response);
+		if(response.alive){
+		//=>if pinged ip is available and responds
+		}	
+	} catch (error) {
+		console.log(error);
+		//=> 'Internal server error ...'
+	}
+})();
+```
+
+### Usage with options and TypeScript
+
+```js
+import ping, {pingResponse, pingOptions} from 'pingman'
+
+(async () => {
+	try {
+		const options: pingOptions = {logToFile:true, numberOfEchos: 6, timeout: 2, IPV4: true};
+		const response: pingResponse = await ping('www.github.com', {logToFile:true, numberOfEchos: 6, timeout: 2, IPV4: true});
+		console.log(response);
+		if(response.alive){
+		//=>if pinged ip is available and responds
+		}
+	} catch (error) {
+		console.log(error);
+		//=> 'Internal server error ...'
+	}
+})();
+```
+
+## Available options
+
+```js
+let response = await ping(TargetIp, {options})
+```
+`TargetIp` can be any valid IPV4 host, IPV6 host or domain name.
+
+The `options` available are based on the docs available for [Windows](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/ping), and the `man` pages for [Mac](https://ss64.com/osx/ping.html) and [Linux](https://linux.die.net/man/8/ping).
+
+There are options which are platform-specific across all three platforms. These are included in the `extendedPingOptions` available and can be found [here](#extended-options). The general options available are abstracted across platforms and should work on all platforms. They can be found in the `pingOptions` object available in types.
+
+| option         | Type        | On Windows    | On Unix          |
+| :---           |    :----:   | :---          | :----            |
+| numeric        | boolean     | -a            | -n               |
+| bufferSize     | number      | -l            | -s               |
+| numberOfEchos  | number      | -n            | -c               |
+| TTL            | number      | -i            | -t(-m for Mac)   |
+| timeout        | number      | -w            | -w(-W for Mac)   |
+| IPV6           | boolean     | -6            | ping6            |
+| IPV4           | boolean     | -4            | ping             |
+
+**Note : The above options are the general options across platforms**
+
+Please specify the `IPV6` option in case the target is an IPV6 address. While in windows it is not required, it is required in unix systems so as to invoke `ping6` command.
+
+There are two further options available: `logToFile` and `logFilePath`. If `logToFile` is set to true, it will log the command and output to a default `log.txt` file at your project root. This is helpful in case you are trying to debug or want a more detailed idea of the output. `logFilePath` can be used in case you want a custom log file path relative to your project root.
+
+## Output Model
+
+```js
+/**
+ * Parsed response
+ * @typedef {pingResponse} pingResponse
+ * @param {string} host - The input IP address or HOST
+ * @param {string} numeric_host - Target IP address
+ * @param {boolean} alive - True for existed host
+ * @param {string} output - Raw stdout from system ping
+ * @param {number} time - Time (float) in ms for first successful ping response
+ * @param {Array<number>} times - Array of Time (float) in ms for each ping response
+ * @param {number} min - Minimum time for collection records
+ * @param {number} max - Maximum time for collection records
+ * @param {number} avg - Average time for collection records
+ * @param {number} bufferSize - Buffer size of each packet sent to target
+ * @param {string} packetLoss - Packet Losses in percent (100% -> "100.000")
+ * @param {string} number - Standard deviation time for collected records
+ */
+```
+
+## Types
+
+Pingman exports some handy TypeScript types and interfaces. See the type definition for all the exported types.
+
+## Extended options
+
+**Note : Using the below options could cause your code to behave unexpectedly in some platforms**
+
+| option          | Type        | On Windows    | On Unix          |
+| :---            |    :----:   | :---          | :----            |
+| recordRouteHops | number      | -r            | N/A              |
+| hopTimestamp    | number      | -s            | N/A              |
+| interval        | number      | N/A           | -i               |
+| soDebugOption   | boolean     | N/A           | -d               |
+| floodPing       | boolean     | N/A           | -f               |
+| interfaceAddress| string      | N/A           | -I               |
+| suppressLoopback| boolean     | N/A           | -L               |
+| pattern         | string      | N/A           | -p               |
+| quiet           | boolean     | N/A           | -q               |
+| timeBeforeExit  | number      | N/A           | -W(-t for Mac)   |
+| verboseOutput   | boolean     | N/A           | -v               |
+| doNotFragment   | boolean     | -f            | -D for Mac       |
+| srcAddr         | string      | -S            | -S for Mac       |
+
+## Contributing
+
+Before opening a pull request please make sure your changes follow the
+[contribution guidelines][1].
+
+[1]: https://github.com/dopecodez/pingman/blob/master/CONTRIBUTING.md
+
+## Contributors
+
+The project would not be the way it is without these rockstars.
+
+<!-- readme: contributors -start -->
+<table>
+	<tbody>
+		<tr>
+            <td align="center">
+                <a href="https://github.com/dopecodez">
+                    <img src="https://avatars.githubusercontent.com/u/34269105?v=4" width="100;" alt="dopecodez"/>
+                    <br />
+                    <sub><b>Govind S</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/lissy93">
+                    <img src="https://avatars.githubusercontent.com/u/1862727?v=4" width="100;" alt="lissy93"/>
+                    <br />
+                    <sub><b>Alicia Sykes</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/Greeshmareji">
+                    <img src="https://avatars.githubusercontent.com/u/57181018?v=4" width="100;" alt="Greeshmareji"/>
+                    <br />
+                    <sub><b>Greeshma R</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/luludotdev">
+                    <img src="https://avatars.githubusercontent.com/u/2358182?v=4" width="100;" alt="luludotdev"/>
+                    <br />
+                    <sub><b>Lulu</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/JesseVermeulen123">
+                    <img src="https://avatars.githubusercontent.com/u/43927190?v=4" width="100;" alt="JesseVermeulen123"/>
+                    <br />
+                    <sub><b>JessC) Vermeulen</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/Sahilhawal">
+                    <img src="https://avatars.githubusercontent.com/u/50511333?v=4" width="100;" alt="Sahilhawal"/>
+                    <br />
+                    <sub><b>Sahil Hawal</b></sub>
+                </a>
+            </td>
+		</tr>
+		<tr>
+            <td align="center">
+                <a href="https://github.com/chebro">
+                    <img src="https://avatars.githubusercontent.com/u/54331348?v=4" width="100;" alt="chebro"/>
+                    <br />
+                    <sub><b>Sravanth C.</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/foxxyz">
+                    <img src="https://avatars.githubusercontent.com/u/2602605?v=4" width="100;" alt="foxxyz"/>
+                    <br />
+                    <sub><b>Foxxyz</b></sub>
+                </a>
+            </td>
+		</tr>
+	<tbody>
+</table>
+<!-- readme: contributors -end -->

package/dist/src/builder/builder.d.ts

@@ -1,3 +1,3 @@
-import { commandBuilder, extendedPingOptions } from '../types';
-declare function builderFactory(ip: string, platform: string, options?: extendedPingOptions): commandBuilder;
-export default builderFactory;
+import { commandBuilder, extendedPingOptions } from '../types';
+declare function builderFactory(ip: string, platform: string, options?: extendedPingOptions): commandBuilder;
+export default builderFactory;

package/dist/src/builder/builder.js

@@ -1,31 +1,31 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const helper_1 = require("../helper");
-const errors_1 = require("../errors");
-const windows_1 = __importDefault(require("./windows"));
-const linux_1 = __importDefault(require("./linux"));
-const mac_1 = __importDefault(require("./mac"));
-const messages_1 = require("../messages");
-//Create instance of builder depending on platform
-function builderFactory(ip, platform, options) {
-    let builder;
-    (0, helper_1.validateIp)(ip);
-    if (!(0, helper_1.isPlatformSupported)(platform)) {
-        throw new errors_1.supportedError(messages_1.ERROR_MESSAGES.PLATFORM_NOT_SUPPORTED.replace('platform', platform));
-    }
-    if (platform === 'win32') {
-        builder = (0, windows_1.default)(ip, options); //creates and builds commands for windows
-    }
-    else if (platform === 'darwin') {
-        builder = (0, mac_1.default)(ip, options); //creates and builds commands for mac
-    }
-    else {
-        builder = (0, linux_1.default)(ip, options); //creates and builds commands for linux
-    }
-    return builder;
-}
-exports.default = builderFactory;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const helper_1 = require("../helper");
+const errors_1 = require("../errors");
+const windows_1 = __importDefault(require("./windows"));
+const linux_1 = __importDefault(require("./linux"));
+const mac_1 = __importDefault(require("./mac"));
+const messages_1 = require("../messages");
+//Create instance of builder depending on platform
+function builderFactory(ip, platform, options) {
+    let builder;
+    (0, helper_1.validateIp)(ip);
+    if (!(0, helper_1.isPlatformSupported)(platform)) {
+        throw new errors_1.supportedError(messages_1.ERROR_MESSAGES.PLATFORM_NOT_SUPPORTED.replace('platform', platform));
+    }
+    if (platform === 'win32') {
+        builder = (0, windows_1.default)(ip, options); //creates and builds commands for windows
+    }
+    else if (platform === 'darwin') {
+        builder = (0, mac_1.default)(ip, options); //creates and builds commands for mac
+    }
+    else {
+        builder = (0, linux_1.default)(ip, options); //creates and builds commands for linux
+    }
+    return builder;
+}
+exports.default = builderFactory;
 //# sourceMappingURL=builder.js.map

package/dist/src/builder/linux.d.ts

@@ -1,3 +1,3 @@
-import { commandBuilder, extendedPingOptions } from '../types';
-declare const linux: (ip: string, options?: extendedPingOptions) => commandBuilder;
-export default linux;
+import { commandBuilder, extendedPingOptions } from '../types';
+declare const linux: (ip: string, options?: extendedPingOptions) => commandBuilder;
+export default linux;