FailedPreconditionError

The operation was rejected because the system is not in a state required for the operation’s execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc.

Service implementors can use the following guidelines to decide between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. For example, if an “rmdir” fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless the files are deleted from the directory.

Extends

• StatusError

Constructors

Constructor

new FailedPreconditionError(init): FailedPreconditionError

Parameters

init

Omit<StatusInit, "code">

Returns

FailedPreconditionError

Overrides

StatusError.constructor

Properties

cause?

optional cause?: unknown

Inherited from

StatusError.cause

---

code

readonly code: Code

Inherited from

StatusError.code

---

details

readonly details: ErrorDetails

Inherited from

StatusError.details

---

httpCode?

readonly optional httpCode?: number

Inherited from

StatusError.httpCode

---

message

message: string

Inherited from

StatusError.message

---

name

name: string

Inherited from

StatusError.name

---

stack?

optional stack?: string

Inherited from

StatusError.stack

---

code

static code: Code = Code.FAILED_PRECONDITION

---

httpCode

static httpCode: number = 400

---

stackTraceLimit

static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

StatusError.stackTraceLimit

Methods

toStatus()

toStatus(): Status

Creates a google.rpc.Status message from this StatusError.

Returns

Status

Inherited from

StatusError.toStatus

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

StatusError.captureStackTrace

---

fromStatus()

static fromStatus(status): StatusError

Creates a StatusError from a google.rpc.Status message.

Parameters

status

Status

Returns

StatusError

Inherited from

StatusError.fromStatus

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

StatusError.prepareStackTrace