Skip to content

Remark the abstract property of Ping #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
u-m-i wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Remark the abstract property of Ping #7

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2093423
[docs] remarks for the signature of `Ping` class
u-m-i Oct 22, 2025
d0a3f5e
[docs] remarks for the signature of `Ping` class
u-m-i Oct 22, 2025
ee7dba2
[merge] updating the local tip
u-m-i Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ Pingus can...
- [Installation](#installation)
- [Simple Example](#simple-example)
- [API](#api)
- Class: [`pingus.Ping`](#class-pingusping)
- Abstract Class: [`pingus.Ping`](#abstract-class-pingusping)
- Event: [`'ready'`](#event-ready)
- Event: [`'result'`](#event-result)
- Event: [`'error'`](#event-error)
- [`ping.send()`](#pingsend)
- Class: [`pingus.PingTCP`](#class-pinguspingtcp-extends-pingusping) Extends: [`pingus.Ping`](#class-pingusping)
- Class: [`pingus.PingTCP`](#class-pinguspingtcp-extends-pingusping) Extends: [`pingus.Ping`](#abstract-class-pingusping)
- [`new PingTCP(options)`](#new-pingtcpoptions)
- [`pingtcp.send()`](#pingtcpsend)
- [`pingtcp.scan()`](#pingtcpscan)
- Class: [`pingus.PingUDP`](#class-pinguspingudp-extends-pingusping) Extends: [`pingus.Ping`](#class-pingusping)
- Class: [`pingus.PingUDP`](#class-pinguspingudp-extends-pingusping) Extends: [`pingus.Ping`](#abstract-class-pingusping)
- [`new PingUDP(options)`](#new-pingudpoptions)
- [`pingudp.send()`](#pingudpsend)
- [`pingudp.scan()`](#pingudpscan)
- Class: [`pingus.PingICMP`](#class-pinguspingicmp-extends-pingusping) Extends: [`pingus.Ping`](#class-pingusping)
- Class: [`pingus.PingICMP`](#class-pinguspingicmp-extends-pingusping) Extends: [`pingus.Ping`](#abstract-class-pingusping)
- [`new PingICMP(options)`](#new-pingicmpoptions)
- [`pingicmp.send()`](#pingicmpsend)
- [`pingicmp.traceroute()`](#pingicmptraceroute)
Expand All @@ -56,7 +56,7 @@ Pingus can...

## Installation

```
``` cmd bash
npm i pingus
```

Expand Down Expand Up @@ -97,16 +97,16 @@ pingus.tcp({ host: 'localhost', port: 22 }).then(console.log);
time: 2,
port: 22,
name: 'ssh',
banner: 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3'
banner: 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3',
toPrimitiveJSON: [Function (anonymous)]
}
```

# API

## Class: `pingus.Ping`
## Abstract Class: `pingus.Ping`

`pingus.Ping` is [`EventEmitter`](https://nodejs.org/docs/latest/api/events.html) with the following events:
`pingus.Ping` is an [`EventEmitter`](https://nodejs.org/docs/latest/api/events.html) with the following events:

### Event: `'ready'`

Expand All @@ -117,7 +117,7 @@ Emitted when ready (Resolve DNS, Filter Bogon IP) to send ping after call [`ping
```js
import pingus from 'pingus';

const ping = new pingus.PingTCP({
const ping = new pingus.PingTCP({ // Using PingTCP not Ping
host: 'example.com',
});
ping.on('ready', (result) => {
Expand All @@ -130,7 +130,7 @@ ping.send();

<details><summary>Result (Console Output)</summary>

```
```text
Copy link
Copy Markdown
Author

@u-m-i u-m-i Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added as suggested here

ping target: example.com
ips: [ '93.184.215.14', '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ]
```
Expand Down Expand Up @@ -185,11 +185,11 @@ Emitted when an error occurs. `result` has last statement before error occurs an

Send ping. See some of examples in [Usage](#usage)

## Class: `pingus.PingTCP` Extends: [`pingus.Ping`](#class-pingusping)
## Class: `pingus.PingTCP` Extends: [`pingus.Ping`](#abstract-class-pingusping)

Class for TCP ping.
<br>
`pingus.PingTCP` is type of [`pingus.Ping`](#class-pingusping)
`pingus.PingTCP` is type of [`pingus.Ping`](#abstract-class-pingusping)

### `new PingTCP(options)`

Expand Down Expand Up @@ -238,10 +238,10 @@ Some of examples in [Usage](#usage).
Scan ports using TCP ping. Return result on Event: [`'result'`](#event-result).
See some of examples in [Usage](#usage).

## Class: `pingus.PingUDP` Extends: [`pingus.Ping`](#class-pingusping)
## Class: `pingus.PingUDP` Extends: [`pingus.Ping`](#abstract-class-pingusping)

Class for UDP ping.<br>
`pingus.PingUDP` is type of [`pingus.Ping`](#class-pingusping)
`pingus.PingUDP` is type of [`pingus.Ping`](#abstract-class-pingusping)

### `new PingUDP(options)`

Expand All @@ -268,11 +268,11 @@ Similar with [`pingtcp.scan()`](#pingtcpscan).<br>
Scan ports using UDP ping. Return result on Event: [`'result'`](#event-result).
See some of examples in [Usage](#usage).

## Class: `pingus.PingICMP` Extends: [`pingus.Ping`](#class-pingusping)
## Class: `pingus.PingICMP` Extends: [`pingus.Ping`](#abstract-class-pingusping)

Class for ICMP ping.
<br>
`pingus.PingICMP` is type of [`pingus.Ping`](#class-pingusping)
`pingus.PingICMP` is type of [`pingus.Ping`](#abstract-class-pingusping)

### `new PingICMP(options)`

Expand Down