import Response from '@pageproof/sdk/src/network/Response.js'

public class | source

Response

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	code: ResponseStatus The application status/error code (do not be fooled, this is not the HTTP status code).
public	data: Object \| Array \| string The usable response data.
public	deprecated: null \| string A deprecation message (if the server responded with a "deprecated" header).
public	error: boolean Whether the response is an error.
public	message: string When the response is an error, this contains an error message.

Public Constructors

public constructor() source

Public Members

public code: ResponseStatus source

The application status/error code (do not be fooled, this is not the HTTP status code).

public data: Object | Array | string source

The usable response data.

When the response is an error, this contains the entire parsed response, otherwise it only contains the usable response data. It's most commonly used to map model data to Models.

public deprecated: null | string source

A deprecation message (if the server responded with a "deprecated" header).

public error: boolean source

Whether the response is an error.

public message: string source

When the response is an error, this contains an error message.

This error message can usually give an indication as to what the issue is. The intention is to make the error message nice enough to present to the user, however in the current implementation - that is not recommended. Instead, construct your own messages from the Response.code.