Class

ApiResponse

ApiResponse(status, responsedata, message)

Helper class for response of Api calls.

Constructor

# new ApiResponse(status, responsedata, message)

Parameters:
Name Type Default Description
status *
responsedata *
message string | null null
Properties:
Name Type Description
status number

Status code like HTTP status codes

data *

Payload

message string | null

Human readable status (optional)

View Source tools/ApiResponse.js, line 20

Classes

ApiResponse

Members

# data

Return status a property

View Source tools/ApiResponse.js, line 74

# message

Return 'message' as property.

See:
  • getMessage()

View Source tools/ApiResponse.js, line 93

number

# status

Return 'status' as property

View Source tools/ApiResponse.js, line 59

Example
...

 if ( obj.status < 300 ) {
   ...
 }

 

Methods

# dump(prefix)

Dump to console.log

Parameters:
Name Type Description
prefix *

View Source tools/ApiResponse.js, line 103

# getData() → {object}

View Source tools/ApiResponse.js, line 67

Response as JSON object

object

# getMessage() → {string|null}

View Source tools/ApiResponse.js, line 82

uman readable status

string | null

# getStatus() → {number}

View Source tools/ApiResponse.js, line 42

Status Code

number