new ClientTcp( [options])
Constructor for a Jayson TCP Client
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
options |
Object | String |
<optional> |
Object goes into options for net.connect, String goes into options.path. String option argument is NOT recommended. |
- Source:
Returns:
- Type
- ClientTcp
Extends
Methods
-
request(method, params [, id] [, callback])
-
Creates a request and dispatches it if given a callback.
Parameters:
Name Type Argument Description method
String | Array A batch request if passed an Array, or a method name if passed a String params
Array | Object Parameters for the method id
String | Number <optional>
Optional id. If undefined an id will be generated. If null it creates a notification request callback
function <optional>
Request callback. If specified, executes the request rather than only returning it. - Inherited From:
- Source:
Throws:
-
Invalid parameters
- Type
- TypeError
Returns:
JSON-RPC 1.0 or 2.0 compatible request- Type
- Object