Logo for jsDocs.io

popsicle-status

  • Version 3.0.0
  • Published
  • 12.2 kB
  • No dependencies
  • MIT license

Install

npm i popsicle-status
yarn add popsicle-status
pnpm add popsicle-status

Overview

Popsicle middleware for rejecting responses with bad HTTP statuses

Index

Functions

Classes

Functions

function status

status: (
    min?: number,
    max?: number
) => <T extends CommonResponse<unknown>>(
    req: CommonRequest<unknown>,
    next: () => Promise<T>
) => Promise<T>;

    Classes

    class StatusError

    class StatusError extends Error {}

      constructor

      constructor(response: CommonResponse, message: string);

        property code

        code: string;

          property response

          response: CommonResponse;

            property status

            status: number;

              Package Files (1)

              Dependencies (0)

              No dependencies.

              Dev Dependencies (14)

              Peer Dependencies (1)

              Badge

              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/popsicle-status.

              • Markdown
                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/popsicle-status)
              • HTML
                <a href="https://www.jsdocs.io/package/popsicle-status"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>