View Source PhxJsonRpc.Types (Phoenix JSON RPC v0.7.0)

@type rpc_error() ::
  nil
  | PhxJsonRpc.Error.InternalError.t()
  | PhxJsonRpc.Error.InvalidParams.t()
  | PhxJsonRpc.Error.InvalidRequest.t()
  | PhxJsonRpc.Error.MethodNotFound.t()
  | PhxJsonRpc.Error.ParseError.t()
  | PhxJsonRpc.Error.ServerError.t()

Type represents possible rpc errors.

rpc_request_id()

@type rpc_request_id() :: nil | binary() | number()

Type represents rpc request ID. Whether it's nil, string or number.

rpc_request_method()

@type rpc_request_method() :: binary()

Type represents called rpc request method in the form of string.

rpc_request_params()

@type rpc_request_params() :: [map()] | map()

Type represents rpc request parameters. In terms of elixir, it's a list or a map.

rpc_response()

@type rpc_response() :: any()

Type represents rpc response.

Functions

parse_params(struct, params \\ [])

@spec parse_params(
  struct(),
  Keyword.t()
) :: any()

Parses parameters, applying them to the given struct, falling back to defaults for the rest.

Settings View Source PhxJsonRpc.Types (Phoenix JSON RPC v0.7.0)

Summary

Types

Functions

Types

jsonrpc_version()

rpc_error()

rpc_request_id()

rpc_request_method()

rpc_request_params()

rpc_response()

Functions

parse_params(struct, params \\ [])

View Source PhxJsonRpc.Types (Phoenix JSON RPC v0.7.0)