Class: JsonRpc

Members

---

isNotification

Determinates is current message is notification

---

isRequest

Determinates is current message is request

---

isResponse

Determinates is current message is response

Methods

---

<static> fireCallback(response)

Fires callback for response if any, if callback not found do nothing

Parameters:

Name	Type	Description
response	JsonRpcResponse

---

<static> getNextId()

Returns id for new request

Returns:

Type

number

---

<static> getOptions()

Gets global options

Returns:

Type

Object

---

<static> getType(message)

Gets message type

Parameters:

Name	Type	Description
message	Object

Throws:

Error

Returns:

Posible values: request, response, notification

Type

string

---

<static> hasValidSyntax(message)

Checks that message has correct syntax

Parameters:

Name	Type	Description
message	Object

Returns:

Type

Boolean

---

<static> isValidNotification(message)

Checks that message is valid notification

Parameters:

Name	Type	Description
message	Object

Returns:

Type

Boolean

---

<static> isValidRequest(message)

Checks that message is valid request

Parameters:

Name	Type	Description
message	Object

Returns:

Type

Boolean

---

<static> isValidResponse(message)

Checks that message is valid response

Parameters:

Name	Type	Description
message	Object

Returns:

Type

Boolean

---

<static> parse(message)

Parse message

Parameters:

Name	Type	Description
message	Object | String

Throws:

Error

Returns:

Type

JsonRpcRequest | JsonRpcResponse | JsonRpcNotification

---

<static> removeCallback(id)

Removes registerd callback if exists

Parameters:

Name	Type	Description
id	Number

---

<static> setOptions(options)

Sets global options

Parameters:

Name	Type	Description
options	Object

---

getCallback()

Gets messeage callback

Returns:

Type

function | undefined

---

getError()

Gets messeage Error

Returns:

Type

JsonRpcError

---

getId()

Gets messeage id

Returns:

Type

Number

---

getMethod()

Gets messeage method

Returns:

Type

String

---

getParams()

Gets messeage parameters for method

Returns:

Type

Object

---

getResource()

Gets messeage resource for method

Returns:

Type

String

---

getResult()

Gets messeage result

Returns:

Type

*

---

getVersion()

Gets messeage schema version

Returns:

Type

String

---

setCallback(callback, tls)

Sets messeage callback

Parameters:

Name	Type	Description
callback	function	Callback to be fired when got response
tls	Number	Time in ms how long keep uncalled callback

Returns:

Type

JsonRpc

---

setError(error)

Sets messeage

Parameters:

Name	Type	Description
error	JsonRpcError | Object

Returns:

Type

JsonRpc

---

setId(id)

Sets messeage id

Parameters:

Name	Type	Description
id	Number

Returns:

Type

JsonRpc

---

setMethod(method)

Sets messeage method

Parameters:

Name	Type	Description
method	String

Returns:

Type

JsonRpc

---

setParams(params)

Sets messeage parameters for method

Parameters:

Name	Type	Description
params	Object

Returns:

Type

JsonRpc

---

setResource(resource)

Sets messeage resource for method

Parameters:

Name	Type	Description
resource	String

Returns:

Type

JsonRpc

---

setResult(result)

Sets messeage result

Parameters:

Name	Type	Description
result	*

Returns:

Type

JsonRpc

---

setVersion(version)

Sets messeage schema version

Parameters:

Name	Type	Description
version	String

Deprecated:

• Will be removed in 1.3.x

---

toJSON()

Returns:

Type

Object

---

toString()

Returns:

Type

String