@cyberok-org/nmap
The JavaScript wrapper around Nmap
Highlights
- TypeScript support.
- ESM modules only.
- Node.js >=14 support.
Install
$ yarn add @cyberok-org/Nmap
# or
$ npm install @cyberok-org/Nmap
Configuration
The package provides 2 ways to configure nmap binary path:
- Environment variable $PATH. It works out of box.
- Environment variable $NMAP_BIN_PATH. You should provide absolute path to nmap.
Usage
import Nmap from '@cyberok-org/nmap'
const results = await Nmap.scan()
.target('192.168.1.1')
.all()
.execute()
Basic
AbortSignal
A command can be aborted. For that purpose the wrapper supports AbortSignal
.
const abortController = new AbortController()
const results = await Nmap()
.target('192.168.1.1')
.all()
.execute({ signal: abortController.signal })