1.0.3 • Published 2 years ago

simple-http-status-codes v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

HTTP Status Codes

A simple library for using HTTP status codes

Installation

Install it from npm and include it in your React build process (using Webpack, Browserify, etc):

npm install --save simple-http-status-codes

Usage

Most basic usage:

import HttpCode from "simple-http-status-codes";

export const checkCode = (): boolean => {
    const httpCode: HttpCode = new HttpCode(200);
    const response: string = ... // Something that could be different

    if (response === "EMAIL_ALREADY_EXISTS") {
        httpCode.setCode(409);
    } else if (response === "USER_CREATED") {
        httpCode.setCode(201);
    }
    
    return httpCode.isSuccessful();
};

HttpCodeModel

The model for a HttpCode looks like this:

export interface HttpCodeModel {
    code: number;
    key: string;
    message: string;
    type: codeType;
}

where codeType is one of:

  • "information"
  • "successful"
  • "redirection"
  • "clientError"
  • "serverError"

Example:

{
    code: 403,
    key: "FORBIDDEN",
    message: "Forbidden",
    type: "clientError"
}

Methods

Instance methods:

namereturn typedescription
getCode()HttpCodeModelReturns the current code.
setCode(x)voidUpdates the current code. Takes a number as argument.
getCodeNumber()numberReturns the current code's number.
getCodeKey()stringReturns the current code's key.
getCodeMessage()stringReturns the current code's Message.
getCodeType()stringReturns the current code's type.
isInformation()booleanReturns true if the current code is of type "information".
isRedirection()booleanReturns true if the current code is of type "redirection".
isSuccessful()booleanReturns true if the current code is of type "successful".
isClientError()booleanReturns true if the current code is of type "clientError".
isServerError()booleanReturns true if the current code is of type "serverError".
isError()booleanReturns true if the current code is of type "clientError" or "serverError".

Class methods:

namereturn typedescription
HttpCode.getInformationCodes()HttpCodeModel[]Returns an array of all "information" codes.
HttpCode.getSuccessfulCodes()HttpCodeModel[]Returns an array of all "redirection" codes.
HttpCode.getRedirectionCodes()HttpCodeModel[]Returns an array of all "successful" codes.
HttpCode.getClientErrorCodes()HttpCodeModel[]Returns an array of all "clientError" codes.
HttpCode.getServerErrorCodes()HttpCodeModel[]Returns an array of all "serverError" codes.