pmcf

Poor mans configuration management

API

Table of Contents

• Base
  • Parameters
  • extends
  • findService
    • Parameters
• port
• socketAddress
• port
• SkeletonNetworkInterface
  • networkAddresses
    • Parameters
• NetworkAddress
  • Parameters
  • subnet
  • networkInterface
  • address
• addresses
  • Parameters
• serviceEndpoints
  • Parameters

Base

Parameters

• owner
• data

extends

Returns Iterable<Base>

findService

Parameters

• filter any

Returns any service with the highest priority

port

Returns number

socketAddress

Returns string

port

Returns number

SkeletonNetworkInterface

Extends ServiceOwner

networkAddresses

Parameters

• filter Object (optional, default n=>true)

Returns Iterable<NetworkAddress>

NetworkAddress

Parameters

• networkInterface
• address
• subnet

subnet

Type: Subnet

networkInterface

Type: NetworkInterface

address

Type: (string | Uint8Array | Uint16Array)

addresses

Parameters

• sources Iterable<(Owner | string)>

• options Object

  • options.aggregate boolean
  • options.filter Object

Returns Iterable[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) addresses

serviceEndpoints

Parameters

• sources any

• options Object? (optional, default {})

  • options.services Function? filter for services
  • options.endpoints Function? filter for endpoints
  • options.select Function? mapper from Endpoint into result
  • options.limit number? upper limit of # result items
  • options.join string? join result(s) into a string

Returns (string | any)

install

With npm do:

npm install pmcf