@protobuf-ts/twirp-transport
Version:
Twirp transport for clients generated by the protoc plugin "protobuf-ts".
124 lines (123 loc) • 5.67 kB
JavaScript
// Copyright 2018 Twitch Interactive, Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"). You may not
// use this file except in compliance with the License. A copy of the License is
// located at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
// CONDITIONS OF ANY KIND, either express or implied. See the License
// for the specific language governing permissions and limitations under
// the License.
/**
* See https://twitchtv.github.io/twirp/docs/spec_v5.html#error-codes
*
* Names and descriptions from [twirp / errors.go](https://github.com/twitchtv/twirp/blob/b2ecb97cf02a9bb55d730920f6a1cb5243899093/errors.go)
*
* Copyright 2018 by Twitch Interactive, Inc.
*/
export var TwirpErrorCode;
(function (TwirpErrorCode) {
/**
* The operation was cancelled.
*/
TwirpErrorCode[TwirpErrorCode["cancelled"] = 0] = "cancelled";
/**
* An unknown error occurred. For example, this can be used when handling
* errors raised by APIs that do not return any error information.
*/
TwirpErrorCode[TwirpErrorCode["unknown"] = 1] = "unknown";
/**
* The client specified an invalid argument. This indicates arguments that
* are invalid regardless of the state of the system (i.e. a malformed
* file name, required argument, number out of range, etc.).
*/
TwirpErrorCode[TwirpErrorCode["invalid_argument"] = 2] = "invalid_argument";
/**
* The client sent a message which could not be decoded. This may mean that
* the message was encoded improperly or that the client and server have
* incompatible message definitions.
*/
TwirpErrorCode[TwirpErrorCode["malformed"] = 3] = "malformed";
/**
* Operation expired before completion. For operations that change the state
* of the system, this error may be returned even if the operation has
* completed successfully (timeout).
*/
TwirpErrorCode[TwirpErrorCode["deadline_exceeded"] = 4] = "deadline_exceeded";
/**
* Some requested entity was not found.
*/
TwirpErrorCode[TwirpErrorCode["not_found"] = 5] = "not_found";
/**
* The requested URL path wasn't routable to a Twirp service and method.
* This is returned by generated server code and should not be returned
* by application code (use "not_found" or "unimplemented" instead).
*/
TwirpErrorCode[TwirpErrorCode["bad_route"] = 6] = "bad_route";
/**
* An attempt to create an entity failed because one already exists.
*/
TwirpErrorCode[TwirpErrorCode["already_exists"] = 7] = "already_exists";
/**
* The caller does not have permission to execute the specified operation.
* It must not be used if the caller cannot be identified (use
* "unauthenticated" instead).
*/
TwirpErrorCode[TwirpErrorCode["permission_denied"] = 8] = "permission_denied";
/**
* The request does not have valid authentication credentials for the
* operation.
*/
TwirpErrorCode[TwirpErrorCode["unauthenticated"] = 9] = "unauthenticated";
/**
* Some resource has been exhausted, perhaps a per-user quota, or
* perhaps the entire file system is out of space.
*/
TwirpErrorCode[TwirpErrorCode["resource_exhausted"] = 10] = "resource_exhausted";
/**
* The operation was rejected because the system is not in a state
* required for the operation's execution. For example, doing an rmdir
* operation on a directory that is non-empty, or on a non-directory
* object, or when having conflicting read-modify-write on the same
* resource.
*/
TwirpErrorCode[TwirpErrorCode["failed_precondition"] = 11] = "failed_precondition";
/**
* The operation was aborted, typically due to a concurrency issue
* like sequencer check failures, transaction aborts, etc.
*/
TwirpErrorCode[TwirpErrorCode["aborted"] = 12] = "aborted";
/**
* The operation was attempted past the valid range. For example, seeking
* or reading past end of a paginated collection. Unlike
* "invalid_argument", this error indicates a problem that may be fixed if
* the system state changes (i.e. adding more items to the collection).
* There is a fair bit of overlap between "failed_precondition" and
* "out_of_range". We recommend using "out_of_range" (the more specific
* error) when it applies so that callers who are iterating through a space
* can easily look for an "out_of_range" error to detect when they are done.
*/
TwirpErrorCode[TwirpErrorCode["out_of_range"] = 13] = "out_of_range";
/**
* The operation is not implemented or not supported/enabled in this service.
*/
TwirpErrorCode[TwirpErrorCode["unimplemented"] = 14] = "unimplemented";
/**
* When some invariants expected by the underlying system have been broken.
* In other words, something bad happened in the library or backend service.
* Twirp specific issues like wire and serialization problems are also
* reported as "internal" errors.
*/
TwirpErrorCode[TwirpErrorCode["internal"] = 15] = "internal";
/**
* The service is currently unavailable. This is most likely a transient
* condition and may be corrected by retrying with a backoff.
*/
TwirpErrorCode[TwirpErrorCode["unavailable"] = 16] = "unavailable";
/**
* The operation resulted in unrecoverable data loss or corruption.
*/
TwirpErrorCode[TwirpErrorCode["dataloss"] = 17] = "dataloss";
})(TwirpErrorCode || (TwirpErrorCode = {}));