@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
| Parameter | Type |
|---|---|
message | string |
status | number |
opts? | { errorCode?: string; retryAfterSeconds?: number; } |
opts.errorCode? | string |
opts.retryAfterSeconds? | number |
Returns
MeClientError
Overrides
Error.constructor
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
<a id="property-errorcode"></a> errorCode | readonly | string | undefined | Server-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> message | public | string | - | Error.message | node_modules/typescript/lib/lib.es5.d.ts:1077 |
<a id="property-name"></a> name | public | string | - | Error.name | node_modules/typescript/lib/lib.es5.d.ts:1076 |
<a id="property-retryafterseconds"></a> retryAfterSeconds | readonly | number | undefined | Seconds 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? | public | string | - | Error.stack | node_modules/typescript/lib/lib.es5.d.ts:1078 |
<a id="property-status"></a> status | readonly | number | - | - | 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