Documentation

AuthenticationError

Thrown when authentication fails.

Constructors

new AuthenticationError(message: string): AuthenticationError

Parameters

Parameter	Type
`message`	`string`

Returns

AuthenticationError

BuildError

Thrown when the build fails.

Extended by

FileUploadError

Constructors

new BuildError(message: string, stackTrace?: string): BuildError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

BuildError

FileUploadError

Thrown when the file upload fails.

Constructors

new FileUploadError(message: string, stackTrace?: string): FileUploadError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

FileUploadError

InvalidArgumentError

Thrown when an invalid argument is provided.

Constructors

new InvalidArgumentError(message: string, stackTrace?: string): InvalidArgumentError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

InvalidArgumentError

NotEnoughSpaceError

Thrown when there is not enough disk space.

Constructors

new NotEnoughSpaceError(message: string, stackTrace?: string): NotEnoughSpaceError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

NotEnoughSpaceError

NotFoundError

Thrown when a resource is not found.

Constructors

new NotFoundError(message: string, stackTrace?: string): NotFoundError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

NotFoundError

RateLimitError

Thrown when the API rate limit is exceeded.

Constructors

new RateLimitError(message: string): RateLimitError

Parameters

Parameter	Type
`message`	`string`

Returns

RateLimitError

SandboxError

Base class for all sandbox errors. Thrown when general sandbox errors occur.

Extended by

TimeoutError
InvalidArgumentError
NotEnoughSpaceError
NotFoundError
TemplateError
RateLimitError

Constructors

new SandboxError(message?: string, stackTrace?: string): SandboxError

Parameters

Parameter	Type
`message`?	`string`
`stackTrace`?	`string`

Returns

SandboxError

TemplateError

Thrown when the template uses old envd version. It isn’t compatible with the new SDK.

Constructors

new TemplateError(message: string, stackTrace?: string): TemplateError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

TemplateError

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 command execution, watch, etc. The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly.

Constructors

new TimeoutError(message: string, stackTrace?: string): TimeoutError

Parameters

Parameter	Type
`message`	`string`
`stackTrace`?	`string`

Returns

TimeoutError

Functions

formatSandboxTimeoutError()

function formatSandboxTimeoutError(message: string): TimeoutError

Parameters

Parameter	Type
`message`	`string`

Returns

TimeoutError

​AuthenticationError

​Constructors

Parameters

Returns

​BuildError

​Extended by

​Constructors

Parameters

Returns

​FileUploadError

​Constructors

Parameters

Returns

​InvalidArgumentError

​Constructors

Parameters

Returns

​NotEnoughSpaceError

​Constructors

Parameters

Returns

​NotFoundError

​Constructors

Parameters

Returns

​RateLimitError

​Constructors

Parameters

Returns

​SandboxError

​Extended by

​Constructors

Parameters

Returns

​TemplateError

​Constructors

Parameters

Returns

​TimeoutError

​Constructors

Parameters

Returns

​Functions

​formatSandboxTimeoutError()

​Parameters

​Returns

AuthenticationError

Constructors

BuildError

Extended by

Constructors

FileUploadError

Constructors

InvalidArgumentError

Constructors

NotEnoughSpaceError

Constructors

NotFoundError

Constructors

RateLimitError

Constructors

SandboxError

Extended by

Constructors

TemplateError

Constructors

TimeoutError

Constructors

Functions

formatSandboxTimeoutError()

Parameters

Returns