nowpayments-api
Version:
NOWPayments API client for Node.js with WebSocket support
70 lines (69 loc) • 2.1 kB
TypeScript
/**
* Custom error classes for NOWPayments API
* @module errors
*/
/**
* Base error class for NOWPayments API errors
* @class NOWPaymentsError
* @extends Error
*/
export class NOWPaymentsError extends Error {
/**
* Creates a base error instance
* @param {string} message - Error message
* @param {string|number} code - Error code
* @param {*} [data] - Additional error data
*/
constructor(message: string, code: string | number, data?: any);
code: string | number;
data: any;
/**
* Returns JSON representation of the error
* @returns {Object} Error JSON representation
*/
toJSON(): Object;
}
/**
* API error class for HTTP request failures
* @class APIError
* @extends NOWPaymentsError
*/
export class APIError extends NOWPaymentsError {
/**
* Creates an API error instance
* @param {string} message - API error message
* @param {number} statusCode - HTTP status code
* @param {Object} [responseData] - API response data
*/
constructor(message: string, statusCode: number, responseData?: Object | undefined);
statusCode: number;
responseData: Object | undefined;
}
/**
* Validation error class for schema validation failures
* @class ValidationError
* @extends NOWPaymentsError
*/
export class ValidationError extends NOWPaymentsError {
/**
* Creates a validation error instance
* @param {string} message - Validation error message
* @param {Object} [details] - Validation error details
*/
constructor(message: string, details?: Object | undefined);
details: Object | undefined;
}
/**
* WebSocket error class for connection failures
* @class WebSocketError
* @extends NOWPaymentsError
*/
export class WebSocketError extends NOWPaymentsError {
/**
* Creates a WebSocket error instance
* @param {string} message - WebSocket error message
* @param {string} code - WebSocket error code
* @param {Object} [details] - Additional error details
*/
constructor(message: string, code: string, details?: Object | undefined);
}