-
Notifications
You must be signed in to change notification settings - Fork 488
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
02bb4b2
commit 47a559b
Showing
6 changed files
with
1,151 additions
and
2 deletions.
There are no files selected for viewing
206 changes: 206 additions & 0 deletions
206
apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.57/errors/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,206 @@ | ||
# errors | ||
|
||
## Classes | ||
|
||
### AuthenticationError | ||
|
||
Thrown when authentication fails. | ||
|
||
#### Constructors | ||
|
||
##### new AuthenticationError() | ||
|
||
> **new AuthenticationError**(`message`): `AuthenticationError` | ||
###### Parameters | ||
|
||
• **message**: `any` | ||
|
||
###### Returns | ||
|
||
`AuthenticationError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:72 | ||
|
||
*** | ||
|
||
### InvalidArgumentError | ||
|
||
Thrown when an invalid argument is provided. | ||
|
||
#### Constructors | ||
|
||
##### new InvalidArgumentError() | ||
|
||
> **new InvalidArgumentError**(`message`): `InvalidArgumentError` | ||
###### Parameters | ||
|
||
• **message**: `string` | ||
|
||
###### Returns | ||
|
||
`InvalidArgumentError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:42 | ||
|
||
*** | ||
|
||
### NotEnoughSpaceError | ||
|
||
Thrown when there is not enough disk space. | ||
|
||
#### Constructors | ||
|
||
##### new NotEnoughSpaceError() | ||
|
||
> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError` | ||
###### Parameters | ||
|
||
• **message**: `string` | ||
|
||
###### Returns | ||
|
||
`NotEnoughSpaceError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:52 | ||
|
||
*** | ||
|
||
### NotFoundError | ||
|
||
Thrown when a resource is not found. | ||
|
||
#### Constructors | ||
|
||
##### new NotFoundError() | ||
|
||
> **new NotFoundError**(`message`): `NotFoundError` | ||
###### Parameters | ||
|
||
• **message**: `string` | ||
|
||
###### Returns | ||
|
||
`NotFoundError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:62 | ||
|
||
*** | ||
|
||
### SandboxError | ||
|
||
Thrown when a sandbox error occurs. | ||
|
||
Base class for all sandbox errors. | ||
|
||
#### Extended by | ||
|
||
- `TimeoutError` | ||
- `InvalidArgumentError` | ||
- `NotEnoughSpaceError` | ||
- `NotFoundError` | ||
- `AuthenticationError` | ||
- `TemplateError` | ||
|
||
#### Constructors | ||
|
||
##### new SandboxError() | ||
|
||
> **new SandboxError**(`message`): `SandboxError` | ||
###### Parameters | ||
|
||
• **message**: `any` | ||
|
||
###### Returns | ||
|
||
`SandboxError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:14 | ||
|
||
*** | ||
|
||
### TemplateError | ||
|
||
Thrown when the template uses old envd version. It isn't compatible with the new SDK. | ||
|
||
#### Constructors | ||
|
||
##### new TemplateError() | ||
|
||
> **new TemplateError**(`message`): `TemplateError` | ||
###### Parameters | ||
|
||
• **message**: `string` | ||
|
||
###### Returns | ||
|
||
`TemplateError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:82 | ||
|
||
*** | ||
|
||
### TimeoutError | ||
|
||
Thrown when a timeout error occurs. | ||
|
||
The [unavailable] error type is caused by sandbox timeout. | ||
|
||
The [canceled] error type is caused by exceeding request timeout. | ||
|
||
The [deadline_exceeded] error type is caused by exceeding the timeout for process, watch, etc. | ||
|
||
The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. | ||
|
||
#### Constructors | ||
|
||
##### new TimeoutError() | ||
|
||
> **new TimeoutError**(`message`): `TimeoutError` | ||
###### Parameters | ||
|
||
• **message**: `string` | ||
|
||
###### Returns | ||
|
||
`TimeoutError` | ||
|
||
###### Defined in | ||
|
||
errors.ts:32 | ||
|
||
## Functions | ||
|
||
### formatSandboxTimeoutError() | ||
|
||
> **formatSandboxTimeoutError**(`message`): `TimeoutError` | ||
#### Parameters | ||
|
||
• **message**: `string` | ||
|
||
#### Returns | ||
|
||
`TimeoutError` | ||
|
||
#### Defined in | ||
|
||
errors.ts:2 |
Oops, something went wrong.