errors.js

Table of Contents

  1. api-reconfigure.js
  2. customconfig.js
  3. default-action.js
  4. oauth.js
  5. simpleclient.js
  6. two-legged.js
  7. user-authentication.js
  8. user-locker.js
  9. user-management.js
  10. api.js
  11. cleaners.js
  12. errors.js
  13. helpers.js
  14. logger.js
  15. oauth.js
  16. parameters.js
  17. request.js
  18. resource.js
  19. responseparser.js 
'use strict';

var util = require('util');

IdendifiedApiError

Marker class for errors that have been identified as known errors communicating with the API. You should not instantiate these directly.

function IdentifiedApiError(){}
util.inherits(IdentifiedApiError, Error);

ApiHttpError

Creates a new ApiHttpError supplied to callbacks when an error response is received at transport level.

function ApiHttpError(statusCode, response, message) {
	this.name = "ApiHttpError";
	this.statusCode = statusCode;
	this.response = response;
	this.message = message || response
		|| util.format('Unexpected %s status code', statusCode);

	if (Error.captureStackTrace
		&& typeof Error.captureStackTrace === 'function') {
		Error.captureStackTrace(this, ApiHttpError);
	}
}

util.inherits(ApiHttpError, IdentifiedApiError);

ApiParseError

Creates a new ApiParseError supplied to callbacks when an invalid or unexpected response is received.

function ApiParseError(parseErrorMessage, response) {
	this.name = "ApiParseError";
	this.response = response;
	this.message = parseErrorMessage;

	if (Error.captureStackTrace
		&& typeof Error.captureStackTrace === 'function') {
		Error.captureStackTrace(this, ApiParseError);
	}
}

util.inherits(ApiParseError, IdentifiedApiError);

OAuthError

Creates a new ApiError supplied to callbacks when a valid error response is received.

function OAuthError(errorResponse, message) {
	this.name = "OAuthError";
	this.message = message || errorResponse.errorMessage;
	this.code = errorResponse.code;
	this.response = errorResponse;

	if (Error.captureStackTrace
		&& typeof Error.captureStackTrace === 'function') {
		Error.captureStackTrace(this, OAuthError);
	}
}

util.inherits(OAuthError, IdentifiedApiError);

ApiError

Creates a new ApiError supplied to callbacks when a valid error response is received.

function ApiError(errorResponse, message) {
	this.name = "ApiError";
	this.message = message || errorResponse.errorMessage;
	this.code = errorResponse.code;
	this.response = errorResponse;

	if (Error.captureStackTrace
		&& typeof Error.captureStackTrace === 'function') {
		Error.captureStackTrace(this, ApiError);
	}
}

util.inherits(ApiError, IdentifiedApiError);

module.exports = {
	ApiHttpError: ApiHttpError,
	ApiParseError: ApiParseError,
	OAuthError: OAuthError,
	ApiError: ApiError,
	IdentifiedApiError: IdentifiedApiError
};
h