v1.0.10

changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2026-05-01 - 1.0.10 - fix(readme)
+refresh README with clearer API documentation and usage examples
+
+- Rewrites the package overview to better explain Smartping, ping, and pingAlive
+- Adds quick start, API reference, usage patterns, and runtime notes for Node.js environments
+- Clarifies timeout behavior and error-handling expectations for health check use cases
+
 ## 2026-05-01 - 1.0.9 - fix(package)
 modernize package configuration and stabilize ping typings and tests
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartping",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "private": false,
   "description": "A utility for performing ping operations in Node.js environments.",
   "exports": {

readme.md

@@ -1,123 +1,156 @@
 # @push.rocks/smartping
-a ping utility
+
+Small, typed, promise-first ping checks for Node.js. `@push.rocks/smartping` wraps the proven [`ping`](https://www.npmjs.com/package/ping) package behind a tiny TypeScript API, so service health checks, diagnostics, readiness probes, and connectivity tests stay easy to read.
+
+It uses the system `ping` command through the underlying dependency, so it is designed for Node.js environments with a working platform ping utility available.
+
+## Issue Reporting and Security
+
+For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
 
 ## Install
 
-To install `@push.rocks/smartping`, run the following command in your project directory:
-
 ```bash
-npm install @push.rocks/smartping --save
+pnpm add @push.rocks/smartping
 ```
 
-This command adds `@push.rocks/smartping` to your project's dependencies and ensures you can begin utilizing it to manage your network ping needs efficiently.
+## What You Get
 
-## Usage
+- `Smartping`: a lightweight class for probing hosts.
+- `ping(host, timeout?)`: returns the full ping response from the underlying `ping.promise.probe(...)` call.
+- `pingAlive(host, timeout?)`: returns a boolean and converts ping failures into `false`.
+- TypeScript types, ESM exports, and direct async/await ergonomics.
 
-`@push.rocks/smartping` leverages TypeScript and ESM syntax for a seamless development experience, offering straightforward methods to conduct ping operations within your applications.
-
-Before diving into the usage scenarios, ensure that you import the module in your TypeScript files using:
-
-```typescript
-import { Smartping } from '@push.rocks/smartping';
-```
-
-### Basic Ping
-
-To perform a basic ping operation to check the reachability of a host, you can do the following:
+## Quick Start
 
 ```typescript
 import { Smartping } from '@push.rocks/smartping';
 
-const pingInstance = new Smartping();
+const smartping = new Smartping();
 
-async function basicPing() {
-  const pingResponse = await pingInstance.ping('google.com');
-  console.log(pingResponse);
-}
+const response = await smartping.ping('127.0.0.1', 1);
 
-basicPing();
+console.log(response.alive); // true when the host responded
+console.log(response.time);  // response time reported by the platform ping utility
 ```
 
-This will output the ping response from `google.com`, including whether the host is alive, the time it took for the response, and other detailed information.
+## API
 
-### Ping with Timeout
+### `new Smartping()`
 
-Sometimes, you may want to specify a timeout for the ping operation to avoid long waiting times if the host is not reachable. You can easily do this as follows:
+Creates a ping helper instance. The class is intentionally stateless, so you can create one per module, per service, or per check without setup.
 
 ```typescript
 import { Smartping } from '@push.rocks/smartping';
 
-const pingInstance = new Smartping();
-
-async function pingWithTimeout() {
-  const pingResponse = await pingInstance.ping('google.com', 1000); // Timeout set to 1000 milliseconds
-  console.log(pingResponse);
-}
-
-pingWithTimeout();
+const smartping = new Smartping();
 ```
 
-### Checking if Host is Alive
+### `smartping.ping(host, timeout?)`
 
-If you're only interested in whether a host is alive without the need for detailed ping information, you can use the `pingAlive` method:
+Runs a ping probe and returns the full response object from `ping.promise.probe(...)`.
+
+```typescript
+const result = await smartping.ping('example.com', 2);
+
+if (result.alive) {
+  console.log(`${result.host} responded in ${result.time}`);
+} else {
+  console.log(`${result.host} did not respond`);
+}
+```
+
+The `timeout` argument is passed to the underlying `ping` package as `timeout`, where it is documented as seconds. If omitted, `@push.rocks/smartping` uses its default value of `500`.
+
+### `smartping.pingAlive(host, timeout?)`
+
+Runs a ping probe and returns only the alive state.
+
+```typescript
+const databaseHostIsReachable = await smartping.pingAlive('10.0.0.5', 1);
+
+if (!databaseHostIsReachable) {
+  throw new Error('Database host is not reachable');
+}
+```
+
+`pingAlive(...)` is useful for health checks because it catches probe errors and returns `false` instead of throwing.
+
+## Usage Patterns
+
+### Service Health Check
 
 ```typescript
 import { Smartping } from '@push.rocks/smartping';
 
-const pingInstance = new Smartping();
+const smartping = new Smartping();
 
-async function checkHostAlive() {
-  const isAlive = await pingInstance.pingAlive('google.com');
-  console.log(`Is Google alive? ${isAlive}`);
-}
-
-checkHostAlive();
+export const checkNetworkDependency = async () => {
+  return smartping.pingAlive('api.internal.example', 1);
+};
 ```
 
-This method is particularly useful for quickly verifying the availability of a server or an API endpoint.
-
-### Advanced Usage Scenarios
-
-`@push.rocks/smartping` can be integrated into health-check mechanisms, automated network diagnostics, server monitoring tools, or any application requiring network communication verification. Its straightforward API and promise-based architecture allow it to be seamlessly incorporated into asynchronous flow control, enhancing both the development experience and performance.
-
-### Error Handling
-
-While using `@push.rocks/smartping`, you might encounter errors, particularly when dealing with unreachable hosts or network issues. It is recommended to implement proper error handling to manage such scenarios gracefully:
+### Diagnostics With Full Response Data
 
 ```typescript
-async function safePingWithTimeout() {
-  try {
-    const pingResponse = await pingInstance.ping('google.com', 500);
-    console.log(pingResponse);
-  } catch (error) {
-    console.error('Ping operation failed:', error);
-  }
-}
+import { Smartping } from '@push.rocks/smartping';
 
-safePingWithTimeout();
+const smartping = new Smartping();
+
+const hosts = ['127.0.0.1', 'example.com', '10.0.0.5'];
+
+for (const host of hosts) {
+  const result = await smartping.ping(host, 1);
+  console.log({
+    host,
+    alive: result.alive,
+    output: result.output,
+    time: result.time,
+  });
+}
 ```
 
-### Wrapping Up
+### Graceful Failure Handling
 
-Whether integrating into existing applications for network diagnostics or constructing a new solution requiring ping capabilities, `@push.rocks/smartping` provides an efficient and easy-to-use interface to accomplish these tasks with minimal code. Its design and implementation cater to modern development practices, promoting clean and maintainable code.
+```typescript
+import { Smartping } from '@push.rocks/smartping';
 
-For more complex scenarios or contributions, please consult the documentation and source code available on GitHub and NPM. Contributions are always welcome to enhance the module's capabilities and address the evolving needs of developers and applications alike.
+const smartping = new Smartping();
+
+try {
+  const result = await smartping.ping('example.com', 1);
+  console.log(result);
+} catch (error) {
+  console.error('Ping probe failed before producing a response:', error);
+}
+```
+
+Use `ping(...)` when you need response details and want to decide how to handle errors yourself. Use `pingAlive(...)` when a simple `true` or `false` is the desired contract.
+
+## Runtime Notes
+
+- This package targets Node.js and ESM-based TypeScript projects.
+- The underlying `ping` package delegates to the operating system ping command.
+- Hosts can be DNS names or IP addresses accepted by the platform ping utility.
+- Timeout behavior is inherited from `ping`, including platform-specific details around system ping arguments.
 
 ## License and Legal Information
 
-This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
 
 **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
 
 ### Trademarks
 
-This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
 
 ### Company Information
 
 Task Venture Capital GmbH  
-Registered at District court Bremen HRB 35230 HB, Germany
+Registered at District Court Bremen HRB 35230 HB, Germany
 
-For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
 
 By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartping',
-  version: '1.0.9',
+  version: '1.0.10',
   description: 'A utility for performing ping operations in Node.js environments.'
 }