Class: ApiRequestBody

ApiRequestBody

Data sent in an API endpoint request for being processed.

new ApiRequestBody()

Create an instance.
Source:

Members


args :Array.<*>

Arguments to pass as function parameters.
Type:
  • Array.<*>
Default Value:
  • []
Source:

cmd :string

The name of the command to run.
Type:
  • string
Source:

<nullable> endpoint :ApiEndpoint

Current endpoint information.
Type:
Source:

Methods


<static> from(obj, cmd)

Convert an api request body to appropriate format.
Parameters:
Name Type Description
obj object Received object of request data from client.
cmd string The command requested to be performed on the endpoint.
Source:
Returns:
Created object of data.
Type
ApiRequestBody