oc · docs
docs / documentation

@orangecheck/me-client


@orangecheck/me-client / MeClientError

Class: MeClientError

Defined in: me-client/src/transport.ts:103

Extends

  • Error

Constructors

Constructor

new MeClientError(
   message: string, 
   status: number, 
   opts?: {
  errorCode?: string;
  retryAfterSeconds?: number;
}): MeClientError;

Defined in: me-client/src/transport.ts:114

Parameters

ParameterType
messagestring
statusnumber
opts?{ errorCode?: string; retryAfterSeconds?: number; }
opts.errorCode?string
opts.retryAfterSeconds?number

Returns

MeClientError

Overrides

Error.constructor

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
<a id="property-errorcode"></a> errorCodereadonlystring | undefinedServer-side error code (the error field on the JSON body, e.g. project_rate_limit_exceeded). Stable across versions; safe to match on. The human-readable message may change.-me-client/src/transport.ts:108
<a id="property-message"></a> messagepublicstring-Error.messagenode_modules/typescript/lib/lib.es5.d.ts:1077
<a id="property-name"></a> namepublicstring-Error.namenode_modules/typescript/lib/lib.es5.d.ts:1076
<a id="property-retryafterseconds"></a> retryAfterSecondsreadonlynumber | undefinedSeconds to wait before retrying. Set when the server responded 429 with a Retry-After header (or a retry_after_seconds body field). Undefined for any other status. Use with withRateLimitRetry() or your own backoff loop.-me-client/src/transport.ts:113
<a id="property-stack"></a> stack?publicstring-Error.stacknode_modules/typescript/lib/lib.es5.d.ts:1078
<a id="property-status"></a> statusreadonlynumber--me-client/src/transport.ts:104

Accessors

isRateLimited

Get Signature

get isRateLimited(): boolean;

Defined in: me-client/src/transport.ts:127

True for the 429 surface · convenience boolean so callers don't have to compare status === 429 every time.

Returns

boolean