oak-tools - Documentation

oak-tools module

Source:

index.js, line 4

Version:

0.2.0

Members

(static) api

Source:

index.js, line 68

Swagger client generator

Methods

(static) advertise(type) → {Mdns}

Source:

index.js, line 60

Service advertiser

Parameters:

Name	Type	Description
`type`	String	Type of advertiser

Returns:

Type: Mdns

(static) client(type) → {WebSocketClient}

Source:

index.js, line 42

Starts a messaging client

Parameters:

Name	Type	Description
`type`	String	Type of client

Returns:

Type: WebSocketClient

(static) discovery(type) → {Mdns}

Source:

index.js, line 51

Service discovery

Parameters:

Name	Type	Description
`type`	String	Type of discovery

Returns:

Type: Mdns

(static) logger(options, callback) → {Logger}

Source:

index.js, line 16

Logger object

Parameters:

Name	Type	Description
`options`	Object	options object
`callback`	function	callback function

Returns:

Type: Logger

(static) message() → {Message}

Source:

index.js, line 24

Message class

Returns:

Type: Message

(static) server(type) → {WebSocketServer}

Source:

index.js, line 33

Starts a messaging server

Parameters:

Name	Type	Description
`type`	String	Type of server

Returns:

Type: WebSocketServer