macoolka-net-ping

This site uses Just the Docs, a documentation theme for Jekyll.

Search

Overview

Table of contents

PortInput (interface)

Signature

interface PortInput {
  hostname?: string
  port?: number
  timeout?: number
}

isPortOpened (constant)

Check a host port is opened

Signature


export const isPortOpened: MonadFunction<PortInput, boolean> = ...

Example

import { isPortOpened, scanHostPort } from 'mocoolka-net-ping'
import * as MN from 'macoolka-app/lib/MonadNode'
import * as E from 'fp-ts/lib/Either'
import { pipe } from 'fp-ts/lib/pipeable'

const result = await pipe(
  isPortOpened({ port: 80, hostname: 'baidu.com' }),
  MN.map(a => assert(a))
)()
assert(E.isRight(result))

Added in v0.2.0

scanHostPort (function)

Get port number that is opened in a host

Signature


export const scanHostPort: MonadFunction<string, number[]> = (hostname) => async () => ...

Example

import { isPortOpened, scanHostPort } from 'mocoolka-net-ping'
import * as MN from 'macoolka-app/lib/MonadNode'
import * as E from 'fp-ts/lib/Either'
import { pipe } from 'fp-ts/lib/pipeable'

const result = await pipe(
  scanHostPort('localhost'),
  MN.map(a => {
    assert(a.length > 0)
  })
)()
assert(E.isRight(result))

Added in v0.2.0