diff --git a/docs/README.md b/docs/README.md index 62b23ef..974da37 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,38 +2,3 @@ > HTTP Exceptions for REST API based on Express.js -See [guide installation](getting-started.md) and our [API](api/index.md) - -## Example - -```typescript - import {BadRequest, Exception} from 'ts-httpexceptions'; - let express = require('express'); - let app = express(); - - app.get('/my/route', (req, res) => { - - throw new BadRequest('Custom Message'); //Emit - // OR - // throw new Exception(510, 'Custom Message'); - - }); - - app.get('/my/route/params', (req, res) => { - - if (req.params.id === undefined){ - throw new BadRequest(); - } - - }); - - - //GlobalHandler middleware catch exception and send response to the client - app.use((err, request, response) => { - - if(err instanceof Exception){ - response.status(err.status).send(err.message); - } - - }); -``` diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 7cc1131..e187c18 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -8,6 +8,6 @@ - Extensible - ES6/Typescript -[GitHub](https://github.com/TypeProject/ts-httpexceptions/) -[Get Started](#tshttpexceptions) +[GitHub](https://github.com/TypedProject/tsed/) +[Get Started](https://tsed.io/docs/exceptions.html) diff --git a/docs/_navbar.md b/docs/_navbar.md index 4fb232d..139597f 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -1,4 +1,2 @@ --
[Getting started](getting-started.md) --
[API references](api/index.md) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index a6ecb14..e69de29 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,4 +0,0 @@ -* [
Getting started](getting-started.md) -* [
API references](api/index.md) -* [
Contributing](contributing.md) -* [
License](license.md) \ No newline at end of file diff --git a/docs/api/common/badgateway.md b/docs/api/common/badgateway.md deleted file mode 100644 index 4881ec8..0000000 --- a/docs/api/common/badgateway.md +++ /dev/null @@ -1,16 +0,0 @@ -

BadGateway

-
Module
import { BadGateway } from "ts-httpexceptions/serverErrors"
Source serverErrors/BadGateway.ts
- -### Overview - -
class BadGateway extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/badmapping.md b/docs/api/common/badmapping.md deleted file mode 100644 index e3150b8..0000000 --- a/docs/api/common/badmapping.md +++ /dev/null @@ -1,16 +0,0 @@ -

BadMapping

-
Module
import { BadMapping } from "ts-httpexceptions/clientErrors"
Source clientErrors/BadMapping.ts
- -### Overview - -
class BadMapping extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/badrequest.md b/docs/api/common/badrequest.md deleted file mode 100644 index c325584..0000000 --- a/docs/api/common/badrequest.md +++ /dev/null @@ -1,16 +0,0 @@ -

BadRequest

-
Module
import { BadRequest } from "ts-httpexceptions/clientErrors"
Source clientErrors/BadRequest.ts
- -### Overview - -
class BadRequest extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/bandwidthlimitexceeded.md b/docs/api/common/bandwidthlimitexceeded.md deleted file mode 100644 index b1a84bf..0000000 --- a/docs/api/common/bandwidthlimitexceeded.md +++ /dev/null @@ -1,16 +0,0 @@ -

BandwidthLimitExceeded

-
Module
import { BandwidthLimitExceeded } from "ts-httpexceptions/serverErrors"
Source serverErrors/BandwidthLimitExceeded.ts
- -### Overview - -
class BandwidthLimitExceeded extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/clientErrors/badmapping.md b/docs/api/common/clientErrors/badmapping.md deleted file mode 100644 index 2bbd86d..0000000 --- a/docs/api/common/clientErrors/badmapping.md +++ /dev/null @@ -1,13 +0,0 @@ -

BadMapping

-
Module
import { BadMapping } from "ts-httpexceptions"
Source clientErrors/BadMapping.ts
- -### Overview - -
class BadMapping extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/badrequest.md b/docs/api/common/clientErrors/badrequest.md deleted file mode 100644 index 36dedde..0000000 --- a/docs/api/common/clientErrors/badrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -

BadRequest

-
Module
import { BadRequest } from "ts-httpexceptions"
Source clientErrors/BadRequest.ts
- -### Overview - -
class BadRequest extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/conflict.md b/docs/api/common/clientErrors/conflict.md deleted file mode 100644 index 10c6db7..0000000 --- a/docs/api/common/clientErrors/conflict.md +++ /dev/null @@ -1,13 +0,0 @@ -

Conflict

-
Module
import { Conflict } from "ts-httpexceptions"
Source clientErrors/Conflict.ts
- -### Overview - -
class Conflict extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/expectationfailed.md b/docs/api/common/clientErrors/expectationfailed.md deleted file mode 100644 index 1e32b77..0000000 --- a/docs/api/common/clientErrors/expectationfailed.md +++ /dev/null @@ -1,13 +0,0 @@ -

ExpectationFailed

-
Module
import { ExpectationFailed } from "ts-httpexceptions"
Source clientErrors/ExpectationFailed.ts
- -### Overview - -
class ExpectationFailed extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/forbidden.md b/docs/api/common/clientErrors/forbidden.md deleted file mode 100644 index 7e99a15..0000000 --- a/docs/api/common/clientErrors/forbidden.md +++ /dev/null @@ -1,13 +0,0 @@ -

Forbidden

-
Module
import { Forbidden } from "ts-httpexceptions"
Source clientErrors/Forbidden.ts
- -### Overview - -
class Forbidden extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/gone.md b/docs/api/common/clientErrors/gone.md deleted file mode 100644 index a716abc..0000000 --- a/docs/api/common/clientErrors/gone.md +++ /dev/null @@ -1,13 +0,0 @@ -

Gone

-
Module
import { Gone } from "ts-httpexceptions"
Source clientErrors/Gone.ts
- -### Overview - -
class Gone extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/imateapot.md b/docs/api/common/clientErrors/imateapot.md deleted file mode 100644 index 2271140..0000000 --- a/docs/api/common/clientErrors/imateapot.md +++ /dev/null @@ -1,13 +0,0 @@ -

ImATeapot

-
Module
import { ImATeapot } from "ts-httpexceptions"
Source clientErrors/ImATeapot.ts
- -### Overview - -
class ImATeapot extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/lengthrequired.md b/docs/api/common/clientErrors/lengthrequired.md deleted file mode 100644 index 0b4a6dd..0000000 --- a/docs/api/common/clientErrors/lengthrequired.md +++ /dev/null @@ -1,13 +0,0 @@ -

LengthRequired

-
Module
import { LengthRequired } from "ts-httpexceptions"
Source clientErrors/LengthRequired.ts
- -### Overview - -
class LengthRequired extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/methodnotallowed.md b/docs/api/common/clientErrors/methodnotallowed.md deleted file mode 100644 index 0a35a02..0000000 --- a/docs/api/common/clientErrors/methodnotallowed.md +++ /dev/null @@ -1,13 +0,0 @@ -

MethodNotAllowed

-
Module
import { MethodNotAllowed } from "ts-httpexceptions"
Source clientErrors/MethodNotAllowed.ts
- -### Overview - -
class MethodNotAllowed extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/misdirectedrequest.md b/docs/api/common/clientErrors/misdirectedrequest.md deleted file mode 100644 index fce68db..0000000 --- a/docs/api/common/clientErrors/misdirectedrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -

MisdirectedRequest

-
Module
import { MisdirectedRequest } from "ts-httpexceptions"
Source clientErrors/MisdirectedRequest.ts
- -### Overview - -
class MisdirectedRequest extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/notacceptable.md b/docs/api/common/clientErrors/notacceptable.md deleted file mode 100644 index 73d4ca6..0000000 --- a/docs/api/common/clientErrors/notacceptable.md +++ /dev/null @@ -1,13 +0,0 @@ -

NotAcceptable

-
Module
import { NotAcceptable } from "ts-httpexceptions"
Source clientErrors/NotAcceptable.ts
- -### Overview - -
class NotAcceptable extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/notfound.md b/docs/api/common/clientErrors/notfound.md deleted file mode 100644 index 83bbeb6..0000000 --- a/docs/api/common/clientErrors/notfound.md +++ /dev/null @@ -1,13 +0,0 @@ -

NotFound

-
Module
import { NotFound } from "ts-httpexceptions"
Source clientErrors/NotFound.ts
- -### Overview - -
class NotFound extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/paymentrequired.md b/docs/api/common/clientErrors/paymentrequired.md deleted file mode 100644 index 982589a..0000000 --- a/docs/api/common/clientErrors/paymentrequired.md +++ /dev/null @@ -1,13 +0,0 @@ -

PaymentRequired

-
Module
import { PaymentRequired } from "ts-httpexceptions"
Source clientErrors/PaymentRequired.ts
- -### Overview - -
class PaymentRequired extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/preconditionfailed.md b/docs/api/common/clientErrors/preconditionfailed.md deleted file mode 100644 index e4de096..0000000 --- a/docs/api/common/clientErrors/preconditionfailed.md +++ /dev/null @@ -1,13 +0,0 @@ -

PreconditionFailed

-
Module
import { PreconditionFailed } from "ts-httpexceptions"
Source clientErrors/PreconditionFailed.ts
- -### Overview - -
class PreconditionFailed extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/preconditionrequired.md b/docs/api/common/clientErrors/preconditionrequired.md deleted file mode 100644 index e1fcb37..0000000 --- a/docs/api/common/clientErrors/preconditionrequired.md +++ /dev/null @@ -1,13 +0,0 @@ -

PreconditionRequired

-
Module
import { PreconditionRequired } from "ts-httpexceptions"
Source clientErrors/PreconditionRequired.ts
- -### Overview - -
class PreconditionRequired extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/proxyauthentificationrequired.md b/docs/api/common/clientErrors/proxyauthentificationrequired.md deleted file mode 100644 index cf3a51e..0000000 --- a/docs/api/common/clientErrors/proxyauthentificationrequired.md +++ /dev/null @@ -1,13 +0,0 @@ -

ProxyAuthentificationRequired

-
Module
import { ProxyAuthentificationRequired } from "ts-httpexceptions"
Source clientErrors/ProxyAuthentificationRequired.ts
- -### Overview - -
class ProxyAuthentificationRequired extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/requestedrangeunsatisfiable.md b/docs/api/common/clientErrors/requestedrangeunsatisfiable.md deleted file mode 100644 index 8cc7ab9..0000000 --- a/docs/api/common/clientErrors/requestedrangeunsatisfiable.md +++ /dev/null @@ -1,13 +0,0 @@ -

RequestedRangeUnsatisfiable

-
Module
import { RequestedRangeUnsatisfiable } from "ts-httpexceptions"
Source clientErrors/RequestedRangeUnsatisfiable.ts
- -### Overview - -
class RequestedRangeUnsatisfiable extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/requestentitytoolarge.md b/docs/api/common/clientErrors/requestentitytoolarge.md deleted file mode 100644 index 52fbba8..0000000 --- a/docs/api/common/clientErrors/requestentitytoolarge.md +++ /dev/null @@ -1,13 +0,0 @@ -

RequestEntityTooLarge

-
Module
import { RequestEntityTooLarge } from "ts-httpexceptions"
Source clientErrors/RequestEntityTooLarge.ts
- -### Overview - -
class RequestEntityTooLarge extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/requestheaderfieldstoolarge.md b/docs/api/common/clientErrors/requestheaderfieldstoolarge.md deleted file mode 100644 index 4781b1f..0000000 --- a/docs/api/common/clientErrors/requestheaderfieldstoolarge.md +++ /dev/null @@ -1,13 +0,0 @@ -

RequestHeaderFieldsTooLarge

-
Module
import { RequestHeaderFieldsTooLarge } from "ts-httpexceptions"
Source clientErrors/RequestHeaderFieldsTooLarge.ts
- -### Overview - -
class RequestHeaderFieldsTooLarge extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/requesttimeout.md b/docs/api/common/clientErrors/requesttimeout.md deleted file mode 100644 index bbb6229..0000000 --- a/docs/api/common/clientErrors/requesttimeout.md +++ /dev/null @@ -1,13 +0,0 @@ -

RequestTimeout

-
Module
import { RequestTimeout } from "ts-httpexceptions"
Source clientErrors/RequestTimeout.ts
- -### Overview - -
class RequestTimeout extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/requesturitoolong.md b/docs/api/common/clientErrors/requesturitoolong.md deleted file mode 100644 index 2f9fff2..0000000 --- a/docs/api/common/clientErrors/requesturitoolong.md +++ /dev/null @@ -1,13 +0,0 @@ -

RequestURITooLong

-
Module
import { RequestURITooLong } from "ts-httpexceptions"
Source clientErrors/RequestURITooLong.ts
- -### Overview - -
class RequestURITooLong extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/toomanyrequests.md b/docs/api/common/clientErrors/toomanyrequests.md deleted file mode 100644 index 6fd4831..0000000 --- a/docs/api/common/clientErrors/toomanyrequests.md +++ /dev/null @@ -1,13 +0,0 @@ -

TooManyRequests

-
Module
import { TooManyRequests } from "ts-httpexceptions"
Source clientErrors/TooManyRequests.ts
- -### Overview - -
class TooManyRequests extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/unauthorized.md b/docs/api/common/clientErrors/unauthorized.md deleted file mode 100644 index 215c7f4..0000000 --- a/docs/api/common/clientErrors/unauthorized.md +++ /dev/null @@ -1,13 +0,0 @@ -

Unauthorized

-
Module
import { Unauthorized } from "ts-httpexceptions"
Source clientErrors/Unauthorized.ts
- -### Overview - -
class Unauthorized extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/unavailabledforlegalreasons.md b/docs/api/common/clientErrors/unavailabledforlegalreasons.md deleted file mode 100644 index 4fb640b..0000000 --- a/docs/api/common/clientErrors/unavailabledforlegalreasons.md +++ /dev/null @@ -1,13 +0,0 @@ -

UnavailabledForLegalReasons

-
Module
import { UnavailabledForLegalReasons } from "ts-httpexceptions"
Source clientErrors/UnavailabledForLegalReasons.ts
- -### Overview - -
class UnavailabledForLegalReasons extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/unprocessableentity.md b/docs/api/common/clientErrors/unprocessableentity.md deleted file mode 100644 index dd78267..0000000 --- a/docs/api/common/clientErrors/unprocessableentity.md +++ /dev/null @@ -1,13 +0,0 @@ -

UnprocessableEntity

-
Module
import { UnprocessableEntity } from "ts-httpexceptions"
Source clientErrors/UnprocessableEntity.ts
- -### Overview - -
class UnprocessableEntity extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/unsupportedmediatype.md b/docs/api/common/clientErrors/unsupportedmediatype.md deleted file mode 100644 index eacfcd5..0000000 --- a/docs/api/common/clientErrors/unsupportedmediatype.md +++ /dev/null @@ -1,13 +0,0 @@ -

UnsupportedMediaType

-
Module
import { UnsupportedMediaType } from "ts-httpexceptions"
Source clientErrors/UnsupportedMediaType.ts
- -### Overview - -
class UnsupportedMediaType extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/clientErrors/upgraderequired.md b/docs/api/common/clientErrors/upgraderequired.md deleted file mode 100644 index fc02fcf..0000000 --- a/docs/api/common/clientErrors/upgraderequired.md +++ /dev/null @@ -1,13 +0,0 @@ -

UpgradeRequired

-
Module
import { UpgradeRequired } from "ts-httpexceptions"
Source clientErrors/UpgradeRequired.ts
- -### Overview - -
class UpgradeRequired extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/conflict.md b/docs/api/common/conflict.md deleted file mode 100644 index 8968792..0000000 --- a/docs/api/common/conflict.md +++ /dev/null @@ -1,16 +0,0 @@ -

Conflict

-
Module
import { Conflict } from "ts-httpexceptions/clientErrors"
Source clientErrors/Conflict.ts
- -### Overview - -
class Conflict extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/core/exception.md b/docs/api/common/core/exception.md deleted file mode 100644 index 03c588b..0000000 --- a/docs/api/common/core/exception.md +++ /dev/null @@ -1,45 +0,0 @@ -

Exception

-
Module
import { Exception } from "ts-httpexceptions"
Source core/Exception.ts
- -### Overview - -
class Exception extends Error {
-    name: string;
-    message: string;
-    type: string;
-    stack: string;
-    origin: Error;
-    status: number;
-    body: any;
-    [key: string]: any;
-    constructor(status?: number, message?: string, origin?: Error | string | any);
-    setOrigin(origin: Error | string | any): void;
-    toString(): string;
-}
- -### Members - -
name: string
-Exception base name -
-
message: string
-Message of the exception -
-
type: string
-Exception type -
-
stack: string
-Stack calling -
-
origin: Error
-
-
status: number
-HTTP Code Status -
-
body: any
-
-
[key: string]: any
-
-
setOrigin(origin: Error | string | any): void
-
-
toString(): string
diff --git a/docs/api/common/core/httpexception.md b/docs/api/common/core/httpexception.md deleted file mode 100644 index 68aba28..0000000 --- a/docs/api/common/core/httpexception.md +++ /dev/null @@ -1,7 +0,0 @@ -

HTTPException

-
Module
import { HTTPException } from "ts-httpexceptions"
Source core/Exception.ts
- -### Overview - -
class HTTPException extends Exception {
-}
diff --git a/docs/api/common/expectationfailed.md b/docs/api/common/expectationfailed.md deleted file mode 100644 index 3b538c3..0000000 --- a/docs/api/common/expectationfailed.md +++ /dev/null @@ -1,16 +0,0 @@ -

ExpectationFailed

-
Module
import { ExpectationFailed } from "ts-httpexceptions/clientErrors"
Source clientErrors/ExpectationFailed.ts
- -### Overview - -
class ExpectationFailed extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/forbidden.md b/docs/api/common/forbidden.md deleted file mode 100644 index 51842e9..0000000 --- a/docs/api/common/forbidden.md +++ /dev/null @@ -1,16 +0,0 @@ -

Forbidden

-
Module
import { Forbidden } from "ts-httpexceptions/clientErrors"
Source clientErrors/Forbidden.ts
- -### Overview - -
class Forbidden extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/gatewaytimeout.md b/docs/api/common/gatewaytimeout.md deleted file mode 100644 index c06d295..0000000 --- a/docs/api/common/gatewaytimeout.md +++ /dev/null @@ -1,16 +0,0 @@ -

GatewayTimeout

-
Module
import { GatewayTimeout } from "ts-httpexceptions/serverErrors"
Source serverErrors/GatewayTimeout.ts
- -### Overview - -
class GatewayTimeout extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/gone.md b/docs/api/common/gone.md deleted file mode 100644 index 16b6a09..0000000 --- a/docs/api/common/gone.md +++ /dev/null @@ -1,16 +0,0 @@ -

Gone

-
Module
import { Gone } from "ts-httpexceptions/clientErrors"
Source clientErrors/Gone.ts
- -### Overview - -
class Gone extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/imateapot.md b/docs/api/common/imateapot.md deleted file mode 100644 index 81f4021..0000000 --- a/docs/api/common/imateapot.md +++ /dev/null @@ -1,16 +0,0 @@ -

ImATeapot

-
Module
import { ImATeapot } from "ts-httpexceptions/clientErrors"
Source clientErrors/ImATeapot.ts
- -### Overview - -
class ImATeapot extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/internalservererror.md b/docs/api/common/internalservererror.md deleted file mode 100644 index 22c9f37..0000000 --- a/docs/api/common/internalservererror.md +++ /dev/null @@ -1,16 +0,0 @@ -

InternalServerError

-
Module
import { InternalServerError } from "ts-httpexceptions/serverErrors"
Source serverErrors/InternalServerError.ts
- -### Overview - -
class InternalServerError extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/lengthrequired.md b/docs/api/common/lengthrequired.md deleted file mode 100644 index fd3cd3a..0000000 --- a/docs/api/common/lengthrequired.md +++ /dev/null @@ -1,16 +0,0 @@ -

LengthRequired

-
Module
import { LengthRequired } from "ts-httpexceptions/clientErrors"
Source clientErrors/LengthRequired.ts
- -### Overview - -
class LengthRequired extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/methodnotallowed.md b/docs/api/common/methodnotallowed.md deleted file mode 100644 index 37f17be..0000000 --- a/docs/api/common/methodnotallowed.md +++ /dev/null @@ -1,16 +0,0 @@ -

MethodNotAllowed

-
Module
import { MethodNotAllowed } from "ts-httpexceptions/clientErrors"
Source clientErrors/MethodNotAllowed.ts
- -### Overview - -
class MethodNotAllowed extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/misdirectedrequest.md b/docs/api/common/misdirectedrequest.md deleted file mode 100644 index 41a1c33..0000000 --- a/docs/api/common/misdirectedrequest.md +++ /dev/null @@ -1,16 +0,0 @@ -

MisdirectedRequest

-
Module
import { MisdirectedRequest } from "ts-httpexceptions/clientErrors"
Source clientErrors/MisdirectedRequest.ts
- -### Overview - -
class MisdirectedRequest extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/movedpermanently.md b/docs/api/common/movedpermanently.md deleted file mode 100644 index b109a56..0000000 --- a/docs/api/common/movedpermanently.md +++ /dev/null @@ -1,16 +0,0 @@ -

MovedPermanently

-
Module
import { MovedPermanently } from "ts-httpexceptions/redirections"
Source redirections/MovedPermanently.ts
- -### Overview - -
class MovedPermanently extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/movedtemporarily.md b/docs/api/common/movedtemporarily.md deleted file mode 100644 index 2dabfea..0000000 --- a/docs/api/common/movedtemporarily.md +++ /dev/null @@ -1,16 +0,0 @@ -

MovedTemporarily

-
Module
import { MovedTemporarily } from "ts-httpexceptions/redirections"
Source redirections/MovedTemporarily.ts
- -### Overview - -
class MovedTemporarily extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/multiplechoices.md b/docs/api/common/multiplechoices.md deleted file mode 100644 index 9deceed..0000000 --- a/docs/api/common/multiplechoices.md +++ /dev/null @@ -1,16 +0,0 @@ -

MultipleChoices

-
Module
import { MultipleChoices } from "ts-httpexceptions/redirections"
Source redirections/MultipleChoices.ts
- -### Overview - -
class MultipleChoices extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/networkauthenticationrequired.md b/docs/api/common/networkauthenticationrequired.md deleted file mode 100644 index 949d413..0000000 --- a/docs/api/common/networkauthenticationrequired.md +++ /dev/null @@ -1,16 +0,0 @@ -

NetworkAuthenticationRequired

-
Module
import { NetworkAuthenticationRequired } from "ts-httpexceptions/serverErrors"
Source serverErrors/NetworkAuthenticationRequired.ts
- -### Overview - -
class NetworkAuthenticationRequired extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/notacceptable.md b/docs/api/common/notacceptable.md deleted file mode 100644 index 72d3125..0000000 --- a/docs/api/common/notacceptable.md +++ /dev/null @@ -1,16 +0,0 @@ -

NotAcceptable

-
Module
import { NotAcceptable } from "ts-httpexceptions/clientErrors"
Source clientErrors/NotAcceptable.ts
- -### Overview - -
class NotAcceptable extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/notextended.md b/docs/api/common/notextended.md deleted file mode 100644 index 7baa1cf..0000000 --- a/docs/api/common/notextended.md +++ /dev/null @@ -1,16 +0,0 @@ -

NotExtended

-
Module
import { NotExtended } from "ts-httpexceptions/serverErrors"
Source serverErrors/NotExtended.ts
- -### Overview - -
class NotExtended extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/notfound.md b/docs/api/common/notfound.md deleted file mode 100644 index ed82158..0000000 --- a/docs/api/common/notfound.md +++ /dev/null @@ -1,16 +0,0 @@ -

NotFound

-
Module
import { NotFound } from "ts-httpexceptions/clientErrors"
Source clientErrors/NotFound.ts
- -### Overview - -
class NotFound extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/notimplemented.md b/docs/api/common/notimplemented.md deleted file mode 100644 index 8ce4104..0000000 --- a/docs/api/common/notimplemented.md +++ /dev/null @@ -1,16 +0,0 @@ -

NotImplemented

-
Module
import { NotImplemented } from "ts-httpexceptions/serverErrors"
Source serverErrors/NotImplemented.ts
- -### Overview - -
class NotImplemented extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/notmodified.md b/docs/api/common/notmodified.md deleted file mode 100644 index 8b82e0b..0000000 --- a/docs/api/common/notmodified.md +++ /dev/null @@ -1,16 +0,0 @@ -

NotModified

-
Module
import { NotModified } from "ts-httpexceptions/redirections"
Source redirections/NotModified.ts
- -### Overview - -
class NotModified extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/paymentrequired.md b/docs/api/common/paymentrequired.md deleted file mode 100644 index 78a8238..0000000 --- a/docs/api/common/paymentrequired.md +++ /dev/null @@ -1,16 +0,0 @@ -

PaymentRequired

-
Module
import { PaymentRequired } from "ts-httpexceptions/clientErrors"
Source clientErrors/PaymentRequired.ts
- -### Overview - -
class PaymentRequired extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/permanentredirect.md b/docs/api/common/permanentredirect.md deleted file mode 100644 index 628aa96..0000000 --- a/docs/api/common/permanentredirect.md +++ /dev/null @@ -1,16 +0,0 @@ -

PermanentRedirect

-
Module
import { PermanentRedirect } from "ts-httpexceptions/redirections"
Source redirections/PermanentRedirect.ts
- -### Overview - -
class PermanentRedirect extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/preconditionfailed.md b/docs/api/common/preconditionfailed.md deleted file mode 100644 index 7ebc233..0000000 --- a/docs/api/common/preconditionfailed.md +++ /dev/null @@ -1,16 +0,0 @@ -

PreconditionFailed

-
Module
import { PreconditionFailed } from "ts-httpexceptions/clientErrors"
Source clientErrors/PreconditionFailed.ts
- -### Overview - -
class PreconditionFailed extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/preconditionrequired.md b/docs/api/common/preconditionrequired.md deleted file mode 100644 index 9f72d84..0000000 --- a/docs/api/common/preconditionrequired.md +++ /dev/null @@ -1,16 +0,0 @@ -

PreconditionRequired

-
Module
import { PreconditionRequired } from "ts-httpexceptions/clientErrors"
Source clientErrors/PreconditionRequired.ts
- -### Overview - -
class PreconditionRequired extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/proxyauthentificationrequired.md b/docs/api/common/proxyauthentificationrequired.md deleted file mode 100644 index ad7b806..0000000 --- a/docs/api/common/proxyauthentificationrequired.md +++ /dev/null @@ -1,16 +0,0 @@ -

ProxyAuthentificationRequired

-
Module
import { ProxyAuthentificationRequired } from "ts-httpexceptions/clientErrors"
Source clientErrors/ProxyAuthentificationRequired.ts
- -### Overview - -
class ProxyAuthentificationRequired extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/proxyerror.md b/docs/api/common/proxyerror.md deleted file mode 100644 index 7b297d9..0000000 --- a/docs/api/common/proxyerror.md +++ /dev/null @@ -1,16 +0,0 @@ -

ProxyError

-
Module
import { ProxyError } from "ts-httpexceptions/serverErrors"
Source serverErrors/ProxyError.ts
- -### Overview - -
class ProxyError extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/redirections/movedpermanently.md b/docs/api/common/redirections/movedpermanently.md deleted file mode 100644 index 5b3294d..0000000 --- a/docs/api/common/redirections/movedpermanently.md +++ /dev/null @@ -1,13 +0,0 @@ -

MovedPermanently

-
Module
import { MovedPermanently } from "ts-httpexceptions"
Source redirections/MovedPermanently.ts
- -### Overview - -
class MovedPermanently extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/movedtemporarily.md b/docs/api/common/redirections/movedtemporarily.md deleted file mode 100644 index 19f7d14..0000000 --- a/docs/api/common/redirections/movedtemporarily.md +++ /dev/null @@ -1,13 +0,0 @@ -

MovedTemporarily

-
Module
import { MovedTemporarily } from "ts-httpexceptions"
Source redirections/MovedTemporarily.ts
- -### Overview - -
class MovedTemporarily extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/multiplechoices.md b/docs/api/common/redirections/multiplechoices.md deleted file mode 100644 index 0d9424a..0000000 --- a/docs/api/common/redirections/multiplechoices.md +++ /dev/null @@ -1,13 +0,0 @@ -

MultipleChoices

-
Module
import { MultipleChoices } from "ts-httpexceptions"
Source redirections/MultipleChoices.ts
- -### Overview - -
class MultipleChoices extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/notmodified.md b/docs/api/common/redirections/notmodified.md deleted file mode 100644 index 42c89dd..0000000 --- a/docs/api/common/redirections/notmodified.md +++ /dev/null @@ -1,13 +0,0 @@ -

NotModified

-
Module
import { NotModified } from "ts-httpexceptions"
Source redirections/NotModified.ts
- -### Overview - -
class NotModified extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/permanentredirect.md b/docs/api/common/redirections/permanentredirect.md deleted file mode 100644 index b1c5002..0000000 --- a/docs/api/common/redirections/permanentredirect.md +++ /dev/null @@ -1,13 +0,0 @@ -

PermanentRedirect

-
Module
import { PermanentRedirect } from "ts-httpexceptions"
Source redirections/PermanentRedirect.ts
- -### Overview - -
class PermanentRedirect extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/seeother.md b/docs/api/common/redirections/seeother.md deleted file mode 100644 index 481b510..0000000 --- a/docs/api/common/redirections/seeother.md +++ /dev/null @@ -1,13 +0,0 @@ -

SeeOther

-
Module
import { SeeOther } from "ts-httpexceptions"
Source redirections/SeeOther.ts
- -### Overview - -
class SeeOther extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/temporaryredirect.md b/docs/api/common/redirections/temporaryredirect.md deleted file mode 100644 index 7c56b5f..0000000 --- a/docs/api/common/redirections/temporaryredirect.md +++ /dev/null @@ -1,13 +0,0 @@ -

TemporaryRedirect

-
Module
import { TemporaryRedirect } from "ts-httpexceptions"
Source redirections/TemporaryRedirect.ts
- -### Overview - -
class TemporaryRedirect extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/toomanyredirects.md b/docs/api/common/redirections/toomanyredirects.md deleted file mode 100644 index 0bd6c8d..0000000 --- a/docs/api/common/redirections/toomanyredirects.md +++ /dev/null @@ -1,13 +0,0 @@ -

TooManyRedirects

-
Module
import { TooManyRedirects } from "ts-httpexceptions"
Source redirections/TooManyRedirects.ts
- -### Overview - -
class TooManyRedirects extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/redirections/useproxy.md b/docs/api/common/redirections/useproxy.md deleted file mode 100644 index c0b907c..0000000 --- a/docs/api/common/redirections/useproxy.md +++ /dev/null @@ -1,13 +0,0 @@ -

UseProxy

-
Module
import { UseProxy } from "ts-httpexceptions"
Source redirections/UseProxy.ts
- -### Overview - -
class UseProxy extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/requestedrangeunsatisfiable.md b/docs/api/common/requestedrangeunsatisfiable.md deleted file mode 100644 index e9a8b71..0000000 --- a/docs/api/common/requestedrangeunsatisfiable.md +++ /dev/null @@ -1,16 +0,0 @@ -

RequestedRangeUnsatisfiable

-
Module
import { RequestedRangeUnsatisfiable } from "ts-httpexceptions/clientErrors"
Source clientErrors/RequestedRangeUnsatisfiable.ts
- -### Overview - -
class RequestedRangeUnsatisfiable extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/requestentitytoolarge.md b/docs/api/common/requestentitytoolarge.md deleted file mode 100644 index 42b717c..0000000 --- a/docs/api/common/requestentitytoolarge.md +++ /dev/null @@ -1,16 +0,0 @@ -

RequestEntityTooLarge

-
Module
import { RequestEntityTooLarge } from "ts-httpexceptions/clientErrors"
Source clientErrors/RequestEntityTooLarge.ts
- -### Overview - -
class RequestEntityTooLarge extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/requestheaderfieldstoolarge.md b/docs/api/common/requestheaderfieldstoolarge.md deleted file mode 100644 index 5a859a6..0000000 --- a/docs/api/common/requestheaderfieldstoolarge.md +++ /dev/null @@ -1,16 +0,0 @@ -

RequestHeaderFieldsTooLarge

-
Module
import { RequestHeaderFieldsTooLarge } from "ts-httpexceptions/clientErrors"
Source clientErrors/RequestHeaderFieldsTooLarge.ts
- -### Overview - -
class RequestHeaderFieldsTooLarge extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/requesttimeout.md b/docs/api/common/requesttimeout.md deleted file mode 100644 index 9611f51..0000000 --- a/docs/api/common/requesttimeout.md +++ /dev/null @@ -1,16 +0,0 @@ -

RequestTimeout

-
Module
import { RequestTimeout } from "ts-httpexceptions/clientErrors"
Source clientErrors/RequestTimeout.ts
- -### Overview - -
class RequestTimeout extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/requesturitoolong.md b/docs/api/common/requesturitoolong.md deleted file mode 100644 index cfdab0d..0000000 --- a/docs/api/common/requesturitoolong.md +++ /dev/null @@ -1,16 +0,0 @@ -

RequestURITooLong

-
Module
import { RequestURITooLong } from "ts-httpexceptions/clientErrors"
Source clientErrors/RequestURITooLong.ts
- -### Overview - -
class RequestURITooLong extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/seeother.md b/docs/api/common/seeother.md deleted file mode 100644 index 6c3e2df..0000000 --- a/docs/api/common/seeother.md +++ /dev/null @@ -1,16 +0,0 @@ -

SeeOther

-
Module
import { SeeOther } from "ts-httpexceptions/redirections"
Source redirections/SeeOther.ts
- -### Overview - -
class SeeOther extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/serverErrors/badgateway.md b/docs/api/common/serverErrors/badgateway.md deleted file mode 100644 index f5ad2ff..0000000 --- a/docs/api/common/serverErrors/badgateway.md +++ /dev/null @@ -1,13 +0,0 @@ -

BadGateway

-
Module
import { BadGateway } from "ts-httpexceptions"
Source serverErrors/BadGateway.ts
- -### Overview - -
class BadGateway extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/bandwidthlimitexceeded.md b/docs/api/common/serverErrors/bandwidthlimitexceeded.md deleted file mode 100644 index 3945af9..0000000 --- a/docs/api/common/serverErrors/bandwidthlimitexceeded.md +++ /dev/null @@ -1,13 +0,0 @@ -

BandwidthLimitExceeded

-
Module
import { BandwidthLimitExceeded } from "ts-httpexceptions"
Source serverErrors/BandwidthLimitExceeded.ts
- -### Overview - -
class BandwidthLimitExceeded extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/gatewaytimeout.md b/docs/api/common/serverErrors/gatewaytimeout.md deleted file mode 100644 index 8e7362f..0000000 --- a/docs/api/common/serverErrors/gatewaytimeout.md +++ /dev/null @@ -1,13 +0,0 @@ -

GatewayTimeout

-
Module
import { GatewayTimeout } from "ts-httpexceptions"
Source serverErrors/GatewayTimeout.ts
- -### Overview - -
class GatewayTimeout extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/internalservererror.md b/docs/api/common/serverErrors/internalservererror.md deleted file mode 100644 index e5b6d7b..0000000 --- a/docs/api/common/serverErrors/internalservererror.md +++ /dev/null @@ -1,13 +0,0 @@ -

InternalServerError

-
Module
import { InternalServerError } from "ts-httpexceptions"
Source serverErrors/InternalServerError.ts
- -### Overview - -
class InternalServerError extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/networkauthenticationrequired.md b/docs/api/common/serverErrors/networkauthenticationrequired.md deleted file mode 100644 index 6ce2700..0000000 --- a/docs/api/common/serverErrors/networkauthenticationrequired.md +++ /dev/null @@ -1,13 +0,0 @@ -

NetworkAuthenticationRequired

-
Module
import { NetworkAuthenticationRequired } from "ts-httpexceptions"
Source serverErrors/NetworkAuthenticationRequired.ts
- -### Overview - -
class NetworkAuthenticationRequired extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/notextended.md b/docs/api/common/serverErrors/notextended.md deleted file mode 100644 index 95390d1..0000000 --- a/docs/api/common/serverErrors/notextended.md +++ /dev/null @@ -1,13 +0,0 @@ -

NotExtended

-
Module
import { NotExtended } from "ts-httpexceptions"
Source serverErrors/NotExtended.ts
- -### Overview - -
class NotExtended extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/notimplemented.md b/docs/api/common/serverErrors/notimplemented.md deleted file mode 100644 index a19f3d4..0000000 --- a/docs/api/common/serverErrors/notimplemented.md +++ /dev/null @@ -1,13 +0,0 @@ -

NotImplemented

-
Module
import { NotImplemented } from "ts-httpexceptions"
Source serverErrors/NotImplemented.ts
- -### Overview - -
class NotImplemented extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/proxyerror.md b/docs/api/common/serverErrors/proxyerror.md deleted file mode 100644 index 89dabe5..0000000 --- a/docs/api/common/serverErrors/proxyerror.md +++ /dev/null @@ -1,13 +0,0 @@ -

ProxyError

-
Module
import { ProxyError } from "ts-httpexceptions"
Source serverErrors/ProxyError.ts
- -### Overview - -
class ProxyError extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/serviceunvailable.md b/docs/api/common/serverErrors/serviceunvailable.md deleted file mode 100644 index 3a5a225..0000000 --- a/docs/api/common/serverErrors/serviceunvailable.md +++ /dev/null @@ -1,13 +0,0 @@ -

ServiceUnvailable

-
Module
import { ServiceUnvailable } from "ts-httpexceptions"
Source serverErrors/ServiceUnvailable.ts
- -### Overview - -
class ServiceUnvailable extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serverErrors/variantalsonegotiates.md b/docs/api/common/serverErrors/variantalsonegotiates.md deleted file mode 100644 index 9e3e9ed..0000000 --- a/docs/api/common/serverErrors/variantalsonegotiates.md +++ /dev/null @@ -1,13 +0,0 @@ -

VariantAlsoNegotiates

-
Module
import { VariantAlsoNegotiates } from "ts-httpexceptions"
Source serverErrors/VariantAlsoNegotiates.ts
- -### Overview - -
class VariantAlsoNegotiates extends Exception {
-    name: string;
-    constructor(message: string);
-}
- -### Members - -
name: string
diff --git a/docs/api/common/serviceunvailable.md b/docs/api/common/serviceunvailable.md deleted file mode 100644 index b426d91..0000000 --- a/docs/api/common/serviceunvailable.md +++ /dev/null @@ -1,16 +0,0 @@ -

ServiceUnvailable

-
Module
import { ServiceUnvailable } from "ts-httpexceptions/serverErrors"
Source serverErrors/ServiceUnvailable.ts
- -### Overview - -
class ServiceUnvailable extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/temporaryredirect.md b/docs/api/common/temporaryredirect.md deleted file mode 100644 index b5d9d2f..0000000 --- a/docs/api/common/temporaryredirect.md +++ /dev/null @@ -1,16 +0,0 @@ -

TemporaryRedirect

-
Module
import { TemporaryRedirect } from "ts-httpexceptions/redirections"
Source redirections/TemporaryRedirect.ts
- -### Overview - -
class TemporaryRedirect extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/toomanyredirects.md b/docs/api/common/toomanyredirects.md deleted file mode 100644 index 8d41955..0000000 --- a/docs/api/common/toomanyredirects.md +++ /dev/null @@ -1,16 +0,0 @@ -

TooManyRedirects

-
Module
import { TooManyRedirects } from "ts-httpexceptions/redirections"
Source redirections/TooManyRedirects.ts
- -### Overview - -
class TooManyRedirects extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/toomanyrequests.md b/docs/api/common/toomanyrequests.md deleted file mode 100644 index a6240a3..0000000 --- a/docs/api/common/toomanyrequests.md +++ /dev/null @@ -1,16 +0,0 @@ -

TooManyRequests

-
Module
import { TooManyRequests } from "ts-httpexceptions/clientErrors"
Source clientErrors/TooManyRequests.ts
- -### Overview - -
class TooManyRequests extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/unauthorized.md b/docs/api/common/unauthorized.md deleted file mode 100644 index f183c51..0000000 --- a/docs/api/common/unauthorized.md +++ /dev/null @@ -1,16 +0,0 @@ -

Unauthorized

-
Module
import { Unauthorized } from "ts-httpexceptions/clientErrors"
Source clientErrors/Unauthorized.ts
- -### Overview - -
class Unauthorized extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/unavailabledforlegalreasons.md b/docs/api/common/unavailabledforlegalreasons.md deleted file mode 100644 index 8277d50..0000000 --- a/docs/api/common/unavailabledforlegalreasons.md +++ /dev/null @@ -1,16 +0,0 @@ -

UnavailabledForLegalReasons

-
Module
import { UnavailabledForLegalReasons } from "ts-httpexceptions/clientErrors"
Source clientErrors/UnavailabledForLegalReasons.ts
- -### Overview - -
class UnavailabledForLegalReasons extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/unprocessableentity.md b/docs/api/common/unprocessableentity.md deleted file mode 100644 index c8ae7d2..0000000 --- a/docs/api/common/unprocessableentity.md +++ /dev/null @@ -1,16 +0,0 @@ -

UnprocessableEntity

-
Module
import { UnprocessableEntity } from "ts-httpexceptions/clientErrors"
Source clientErrors/UnprocessableEntity.ts
- -### Overview - -
class UnprocessableEntity extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/unsupportedmediatype.md b/docs/api/common/unsupportedmediatype.md deleted file mode 100644 index be8cb44..0000000 --- a/docs/api/common/unsupportedmediatype.md +++ /dev/null @@ -1,16 +0,0 @@ -

UnsupportedMediaType

-
Module
import { UnsupportedMediaType } from "ts-httpexceptions/clientErrors"
Source clientErrors/UnsupportedMediaType.ts
- -### Overview - -
class UnsupportedMediaType extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/upgraderequired.md b/docs/api/common/upgraderequired.md deleted file mode 100644 index cb554a2..0000000 --- a/docs/api/common/upgraderequired.md +++ /dev/null @@ -1,16 +0,0 @@ -

UpgradeRequired

-
Module
import { UpgradeRequired } from "ts-httpexceptions/clientErrors"
Source clientErrors/UpgradeRequired.ts
- -### Overview - -
class UpgradeRequired extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/useproxy.md b/docs/api/common/useproxy.md deleted file mode 100644 index 4863b04..0000000 --- a/docs/api/common/useproxy.md +++ /dev/null @@ -1,16 +0,0 @@ -

UseProxy

-
Module
import { UseProxy } from "ts-httpexceptions/redirections"
Source redirections/UseProxy.ts
- -### Overview - -
class UseProxy extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/common/variantalsonegotiates.md b/docs/api/common/variantalsonegotiates.md deleted file mode 100644 index 4140fb3..0000000 --- a/docs/api/common/variantalsonegotiates.md +++ /dev/null @@ -1,16 +0,0 @@ -

VariantAlsoNegotiates

-
Module
import { VariantAlsoNegotiates } from "ts-httpexceptions/serverErrors"
Source serverErrors/VariantAlsoNegotiates.ts
- -### Overview - -
class VariantAlsoNegotiates extends Exception {
-    static readonly STATUS: number;
-    name: string;
-    constructor(message: string, origin?: Error | string | any);
-}
- -### Members - -
static readonly STATUS: number
-
-
name: string
diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index 400efb7..0000000 --- a/docs/api/index.md +++ /dev/null @@ -1,29 +0,0 @@ -# Api - -
-
  • All
  • Decorator
  • Class
  • Enum
  • Function
  • Interface
  • Constant
  • Service
  • Type alias
  • All
  • Stable
  • Deprecated
  • Experimental
  • Private
  • Public
search
-
- - -#### common/core - - - - -#### common/appenders - - - - -#### common/layouts - - - - -#### common/logger - - - -
- diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index 404953d..0000000 --- a/docs/contributing.md +++ /dev/null @@ -1,45 +0,0 @@ -# Contributing - -## Setup - -Clone your fork of the repository - -``` -$ git clone https://github.com/YOUR_USERNAME/ts-httpexceptions.git -``` - -Install npm dependencies - -``` -npm install -``` - -Run build process - -``` -npm run tsc:compile -``` - -## Test - -``` -npm run test -``` - -## Write documentation - -Ts.HttpExceptions use docsify to convert markdown to HTML. In addition, all documentation in your code will be used to generate -the Api documentation. To preview your comments on a class you can run this command: - -``` -npm run doc:serve -``` - -## Guidelines - -- Ts.HttpExceptions follow the git flow to generate a release note. To write your commit message see https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit -- Please try to combine multiple commits before pushing -- Please use TDD when fixing bugs. This means that you should write a unit test that fails because it reproduces the issue, then fix the issue and finally run the test to ensure that the issue has been resolved. This helps us prevent fixed bugs from happening again in the future -- Please keep the test coverage at 99%. Write additional unit tests if necessary -- Please create an issue before sending a PR if it is going to change the public interface of Ts.ED or includes significant architecture changes, -- Feel free to ask for help from other members of the Ts.HttpExceptions team \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md deleted file mode 100644 index 3406672..0000000 --- a/docs/getting-started.md +++ /dev/null @@ -1,64 +0,0 @@ -# Getting started - -## Installation - -You can get the latest release using npm: - -```batch -$ npm install --save ts-httpexceptions -``` - -> **Important!** Ts.ED requires Node >= 8 and TypeScript >= 2.0. - - -## Example - -```typescript -import {BadRequest, Exception, NotFound} from 'ts-httpexceptions'; -const express = require('express'); // Koa works also -const app = express(); - -app.get('/my/route/:id', async (req, res, next) => { - if (req.params.id === undefined) { - const error = new BadRequest("ID is required") - - // Additionally - error.headers = { - 'x-header': 'value' - } - error.errors = [{'message': "ID is required"}] - error.body = [{'message': "ID is required"}] - - next(error); - } - - try { - const user = await getUser(res.params.id) - res.json(user); - } catch(origin) { - next(new NotFound('User not found', origin)) - } -}); - - -//GlobalHandler middleware catch exception and send response to the client -app.use((err, request, response, next) => { - if(err instanceof Exception) { - if (err.errors) { // If errors is provided - response.set({'x-errors': JSON.stringify(err.errors)}) - } - - if (err.headers) { - response.set(err.headers) - } - - if (err.body) { // If a body is provided - return response.status(err.status).json(err.body) - } - - return response.status(err.status).send(err.message); - } - - next() -}); -```