{"id":20288005,"url":"https://github.com/dopecodez/pingman","last_synced_at":"2026-06-06T16:00:54.655Z","repository":{"id":42656527,"uuid":"262558045","full_name":"dopecodez/pingman","owner":"dopecodez","description":"Wrapper for ping module with node and no dependencies.","archived":false,"fork":false,"pushed_at":"2026-06-06T14:30:48.000Z","size":735,"stargazers_count":37,"open_issues_count":1,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-06-06T15:22:45.608Z","etag":null,"topics":["ava","hacktoberfest","node","node-ping","nodejs","npm-package","ping","ping-server","travis-ci","typescript","typescript-definitions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dopecodez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-09T11:41:04.000Z","updated_at":"2026-06-06T14:30:52.000Z","dependencies_parsed_at":"2023-02-03T18:30:37.065Z","dependency_job_id":"8c0d8b9e-04f6-45d9-84e6-69c9c2e24e2d","html_url":"https://github.com/dopecodez/pingman","commit_stats":{"total_commits":116,"total_committers":10,"mean_commits":11.6,"dds":"0.22413793103448276","last_synced_commit":"700d75dba9f7385f04b9e4a3fc217df3326225f9"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/dopecodez/pingman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dopecodez%2Fpingman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dopecodez%2Fpingman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dopecodez%2Fpingman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dopecodez%2Fpingman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dopecodez","download_url":"https://codeload.github.com/dopecodez/pingman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dopecodez%2Fpingman/sbom","scorecard":{"id":352463,"data":{"date":"2025-08-11","repo":{"name":"github.com/dopecodez/pingman","commit":"a848e2b9c128e355b69daf02eec31c5dfadb8651"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 2/21 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/contributors.yml:1","Warn: no topLevel permission defined: .github/workflows/main.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/contributors.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/dopecodez/pingman/contributors.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/dopecodez/pingman/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/dopecodez/pingman/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/dopecodez/pingman/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/dopecodez/pingman/main.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/dopecodez/pingman/main.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/main.yml:33","Warn: npmCommand not pinned by hash: .github/workflows/main.yml:44","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 13 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T08:40:57.007Z","repository_id":42656527,"created_at":"2025-08-18T08:40:57.007Z","updated_at":"2025-08-18T08:40:57.007Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33988667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-06T02:00:07.033Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ava","hacktoberfest","node","node-ping","nodejs","npm-package","ping","ping-server","travis-ci","typescript","typescript-definitions"],"created_at":"2024-11-14T14:43:41.136Z","updated_at":"2026-06-06T16:00:54.612Z","avatar_url":"https://github.com/dopecodez.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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)\n\nHuman-friendly node wrapper for ping utility across platforms.\n\nAdd ping utility to your projects with zero dependencies. Build with latest ES6 features with native support for async/await and promises.\n\nNewly released and actively maintained. Small unpacked size.\n\n# INSTALLATION\n\n```\n$ npm install pingman\n```\n\n## Highlights\n\n- [Usage](#Usage)\n- [Available options](#available-options)\n- [Output Model](#output-model)\n- [Types](#types)\n- [Extended options(Platform-specific)](#extended-options)\n- [Contributing](#contributing)\n\n## Usage\n\n```js\nconst ping = require('pingman');\n\n(async () =\u003e {\n\ttry {\n\t\tconst response = await ping('127.0.0.1');\n\t\tconsole.log(response);\n\t\tif(response.alive){\n\t\t//=\u003eif pinged ip is available and responds\n\t\t}\t\n\t} catch (error) {\n\t\tconsole.log(error);\n\t\t//=\u003e 'Internal server error ...'\n\t}\n})();\n```\n\n### Usage with options and TypeScript\n\n```js\nimport ping, {pingResponse, pingOptions} from 'pingman'\n\n(async () =\u003e {\n\ttry {\n\t\tconst options: pingOptions = {logToFile:true, numberOfEchos: 6, timeout: 2, IPV4: true};\n\t\tconst response: pingResponse = await ping('www.github.com', {logToFile:true, numberOfEchos: 6, timeout: 2, IPV4: true});\n\t\tconsole.log(response);\n\t\tif(response.alive){\n\t\t//=\u003eif pinged ip is available and responds\n\t\t}\n\t} catch (error) {\n\t\tconsole.log(error);\n\t\t//=\u003e 'Internal server error ...'\n\t}\n})();\n```\n\n## Available options\n\n```js\nlet response = await ping(TargetIp, {options})\n```\n`TargetIp` can be any valid IPV4 host, IPV6 host or domain name.\n\nThe `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).\n\nThere 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.\n\n| option         | Type        | On Windows    | On Unix          |\n| :---           |    :----:   | :---          | :----            |\n| numeric        | boolean     | -a            | -n               |\n| bufferSize     | number      | -l            | -s               |\n| numberOfEchos  | number      | -n            | -c               |\n| TTL            | number      | -i            | -t(-m for Mac)   |\n| timeout        | number      | -w            | -w(-W for Mac)   |\n| IPV6           | boolean     | -6            | ping6            |\n| IPV4           | boolean     | -4            | ping             |\n\n**Note : The above options are the general options across platforms**\n\nPlease 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.\n\nThere 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.\n\n## Output Model\n\n```js\n/**\n * Parsed response\n * @typedef {pingResponse} pingResponse\n * @param {string} host - The input IP address or HOST\n * @param {string} numeric_host - Target IP address\n * @param {boolean} alive - True for existed host\n * @param {string} output - Raw stdout from system ping\n * @param {number} time - Time (float) in ms for first successful ping response\n * @param {Array\u003cnumber\u003e} times - Array of Time (float) in ms for each ping response\n * @param {number} min - Minimum time for collection records\n * @param {number} max - Maximum time for collection records\n * @param {number} avg - Average time for collection records\n * @param {number} bufferSize - Buffer size of each packet sent to target\n * @param {string} packetLoss - Packet Losses in percent (100% -\u003e \"100.000\")\n * @param {string} number - Standard deviation time for collected records\n */\n```\n\n## Types\n\nPingman exports some handy TypeScript types and interfaces. See the type definition for all the exported types.\n\n## Extended options\n\n**Note : Using the below options could cause your code to behave unexpectedly in some platforms**\n\n| option          | Type        | On Windows    | On Unix          |\n| :---            |    :----:   | :---          | :----            |\n| recordRouteHops | number      | -r            | N/A              |\n| hopTimestamp    | number      | -s            | N/A              |\n| interval        | number      | N/A           | -i               |\n| soDebugOption   | boolean     | N/A           | -d               |\n| floodPing       | boolean     | N/A           | -f               |\n| interfaceAddress| string      | N/A           | -I               |\n| suppressLoopback| boolean     | N/A           | -L               |\n| pattern         | string      | N/A           | -p               |\n| quiet           | boolean     | N/A           | -q               |\n| timeBeforeExit  | number      | N/A           | -W(-t for Mac)   |\n| verboseOutput   | boolean     | N/A           | -v               |\n| doNotFragment   | boolean     | -f            | -D for Mac       |\n| srcAddr         | string      | -S            | -S for Mac       |\n\n## Contributing\n\nBefore opening a pull request please make sure your changes follow the\n[contribution guidelines][1].\n\n[1]: https://github.com/dopecodez/pingman/blob/master/CONTRIBUTING.md\n\n## Contributors\n\nThe project would not be the way it is without these rockstars.\n\n\u003c!-- readme: contributors -start --\u003e\n\u003ctable\u003e\n\t\u003ctbody\u003e\n\t\t\u003ctr\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/dopecodez\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/34269105?v=4\" width=\"100;\" alt=\"dopecodez\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eGovind S\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/lissy93\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/1862727?v=4\" width=\"100;\" alt=\"lissy93\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eAlicia Sykes\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/Greeshmareji\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/57181018?v=4\" width=\"100;\" alt=\"Greeshmareji\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eGreeshma R\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/luludotdev\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/2358182?v=4\" width=\"100;\" alt=\"luludotdev\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eLulu\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/JesseVermeulen123\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/43927190?v=4\" width=\"100;\" alt=\"JesseVermeulen123\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eJessC) Vermeulen\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/Sahilhawal\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/50511333?v=4\" width=\"100;\" alt=\"Sahilhawal\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eSahil Hawal\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n\t\t\u003c/tr\u003e\n\t\t\u003ctr\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/chebro\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/54331348?v=4\" width=\"100;\" alt=\"chebro\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eSravanth C.\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\n                \u003ca href=\"https://github.com/foxxyz\"\u003e\n                    \u003cimg src=\"https://avatars.githubusercontent.com/u/2602605?v=4\" width=\"100;\" alt=\"foxxyz\"/\u003e\n                    \u003cbr /\u003e\n                    \u003csub\u003e\u003cb\u003eFoxxyz\u003c/b\u003e\u003c/sub\u003e\n                \u003c/a\u003e\n            \u003c/td\u003e\n\t\t\u003c/tr\u003e\n\t\u003ctbody\u003e\n\u003c/table\u003e\n\u003c!-- readme: contributors -end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdopecodez%2Fpingman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdopecodez%2Fpingman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdopecodez%2Fpingman/lists"}