Constructor

HttpsError

new HttpsError(code, message, details)

To send an error from an HTTPS Callable function to a client, throw an instance of this class from your handler function.

Make sure to throw this exception at the top level of your function and not from within a callback, as that will not necessarily terminate the function with this exception.

Parameter

code

string

A status error code to include in the response. This determines the HTTP response status code. For example, if you throw new HttpsError('not-found'), the HTTP response is 404, and the client receives the NOT_FOUND error code. The value must be one of the canonical error codes for Google APIs, and uses the HTTP status mapping defined in that proto. Possible values:

  • cancelled: The operation was cancelled (typically by the caller).
  • unknown: Unknown error or an error from a different error domain.
  • invalid-argument: Client specified an invalid argument. Note that this differs from failed-precondition. invalid-argument indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name).
  • deadline-exceeded: Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.
  • not-found: Some requested document was not found.
  • already-exists: Some document that we attempted to create already exists.
  • permission-denied: The caller does not have permission to execute the specified operation.
  • resource-exhausted: Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
  • failed-precondition: Operation was rejected because the system is not in a state required for the operation`s execution.
  • aborted: The operation was aborted, typically due to a concurrency issue like transaction aborts, etc.
  • out-of-range: Operation was attempted past the valid range.
  • unimplemented: Operation is not implemented or not supported/enabled.
  • internal: Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
  • unavailable: The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff.
  • data-loss: Unrecoverable data loss or corruption.
  • unauthenticated: The request does not have valid authentication credentials for the operation.

message

string

A message string to be included in the response body to the client.

details

any type

An object to include in the "details" field of the response body. As with the data returned from a callable HTTPS handler, this can be null or any string, number, boolean, object, or array.

Extends
Error