dotnet-responses

A collection of response classes that mimic ASP.NET responses.

Table of Contents

• dotnet-responses
  • Table of Contents
  • Install
  • Basic Usage
    • Using Objects
    • Using Static Classes
    • Importing All Classes
  • Constructors
    • Classes With a Default Status Code of 100-308
    • Classes With a Default Status Code of 400-599
    • Base Response
  • Object Functions
    • status
    • sendStatus
    • send
    • json
    • jsonp
    • end
  • Static Functions
    • status
    • sendStatus
    • send
    • json
    • jsonp
    • end
  • List of Classes
    • Format of List
    • 100s
    • 200s
    • 300s
    • 400s
    • 500s
    • Base
  • Helper Functions
    • getResponseByStatusCode
  • Contributing
  • License

Install

This is a Node.js module available through the npm registry.

1$ npm install dotnet-responses

Basic Usage

Using Objects

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function (req, res) {
6    /*
7    Call res.send and send the following object to the client:
8    {
9        "statusCode": 200,
10        "message": "Ok",
11        "data": null,
12        "error": null
13    }
14    */
15    const ok = new Ok({ res });
16    ok.send();
17});
18
19app.listen(3000);

Using Static Classes

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function (req, res) {
6    /*
7    Call res.send and send the following object to the client:
8    {
9        "statusCode": 200,
10        "message": "Ok",
11        "data": null,
12        "error": null
13    }
14    */
15    Ok.send({ res });
16});
17
18app.listen(3000);

Importing All Classes

1const express = require("express");
2const app = express();
3const Responses = require("dotnet-responses");
4
5app.get("/ok", function (req, res) {
6    /*
7    Call res.send and send the following object to the client:
8    {
9        "statusCode": 200,
10        "message": "Ok",
11        "data": null,
12        "error": null
13    }
14    */
15    Responses.Ok.send({ res });
16    
17    /*
18    Can also do:
19    const ok = new Responses.Ok({ res });
20    ok.send();
21    */
22});
23
24app.listen(3000);

Constructors

Classes With a Default Status Code of 100-308

1const { Ok } = require("dotnet-responses");
2new Ok({
3    res,        // Response object from express
4    message,    // String (optional)
5    data,       // Object or Array (optional)
6});

Classes With a Default Status Code of 400-599

1const { BadRequest } = require("dotnet-responses");
2new BadRequest({
3    res,        // Response object from express
4    message,    // String (optional)
5    data,       // Object or Array (optional)
6    error,      // Object (optional)
7});

Base Response

1const { Response } = require("dotnet-responses");
2new Response({
3    statusCode, // Number (optional)
4    message,    // String (optional)
5    data,       // Object or Array (optional)
6    error,      // Object (optional)
7});
8
9/*
10Response has no functions, it just stores the data passed into its constructor
11
12Response's default data:
13{
14    "statusCode": 200,
15    "message": null,
16    "data": null,
17    "error": null
18}
19*/

Object Functions

status

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function(req, res)
6{
7    // Call res.status to set statusCode to 200
8    // (This example serves no functional purpose, as Ok has a status code of 200 by default)
9    const ok = new Ok({ res });
10    ok.status(
11        200     // Number
12    );
13    ok.send();
14});
15
16app.listen(3000);

sendStatus

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function(req, res)
6{
7    // Call res.sendStatus to send response of "Ok" to client
8    const ok = new Ok({ res });
9    ok.sendStatus(
10        200     // Number
11    );
12});
13
14app.listen(3000);

send

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function(req, res)
6{
7    /*
8    Call res.send and send the following object to the client:
9    {
10        "statusCode": 200,
11        "message": "Ok",
12        "data": null,
13        "error": null
14    }
15    */
16    const ok = new Ok({ res });
17    ok.send(/* No parameters */);
18});
19
20app.listen(3000);

json

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function(req, res)
6{
7    /*
8    Call res.json and send the following object to the client:
9    {
10        "statusCode": 200,
11        "message": "Ok",
12        "data": null,
13        "error": null
14    }
15    */
16    const ok = new Ok({ res });
17    ok.json(/* No parameters */);
18});
19
20app.listen(3000);

jsonp

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function(req, res)
6{
7    /*
8    Call res.jsonp and send the following object to the client:
9    {
10        "statusCode": 200,
11        "message": "Ok",
12        "data": null,
13        "error": null
14    }
15    */
16    const ok = new Ok({ res });
17    ok.jsonp(/* No parameters */);
18});
19
20app.listen(3000);

end

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function(req, res)
6{
7    // Call res.end
8    const ok = new Ok({ res });
9    ok.end(/* No parameters */);
10});
11
12app.listen(3000);

Static Functions

status

1const express = require("express");
2const app = express();
3const { BadRequest } = require("dotnet-responses");
4
5app.get("/bad-request", function(req, res)
6{
7    // Call res.status to set statusCode to 400
8    // (This example serves no functional purpose, as BadRequest has a status code of 400 by default)
9    BadRequest.status({
10        res,                                // Response object from express
11        statusCode: 400,                    // Number (optional)
12    });
13    BadRequest.send({ res });
14});
15
16app.listen(3000);

sendStatus

1const express = require("express");
2const app = express();
3const { BadRequest } = require("dotnet-responses");
4
5app.get("/bad-request", function(req, res)
6{
7    // Call res.sendStatus to send response of "Bad Request" to client
8    BadRequest.sendStatus({
9        res,                                // Response object from express
10        statusCode: 400,                    // Number (optional)
11    });
12});
13
14app.listen(3000);

send

1const express = require("express");
2const app = express();
3const { NotFound } = require("dotnet-responses");
4
5app.get("/*", function(req, res)
6{
7    /*
8    Call res.send and send the following object to the client:
9    {
10        "statusCode": 404,
11        "message": "Not Found",
12        "data": {
13        "foo": "bar"
14        },
15        "error": {
16            // Info about your error here
17        }
18    }
19    */
20    NotFound.send({
21        res,                                // Response object from express
22        statusCode: 404,                    // Number (optional)
23        message: "Not Found",               // String (optional)
24        data: { foo: "bar" },               // Object or Array (optional)
25        error: new Error("Page not found"), // Object (optional)
26    });
27});
28
29app.listen(3000);

json

1const express = require("express");
2const app = express();
3const { Ok, UnprocessableEntity } = require("dotnet-responses");
4
5const bodyParser = require("body-parser");
6app.use(bodyParser.json());
7app.use(bodyParser.urlencoded({ extended: true }));
8
9const { validateMyPayloadAsync } = require("./some-file-for-custom-validation");
10
11app.post("/validation-error", function(req, res)
12{
13    validateMyPayloadAsync(req.body)
14    .then((result) => {
15        /*
16        Call res.json and send the following object to the client:
17        {
18            "statusCode": 200,
19            "message": "Ok",
20            "data": {
21                // Info about result here
22            },
23            "error": {
24                // Info about your error here
25            }
26        }
27        */
28        Ok.json({
29            res,                            // Response object from express
30            statusCode: 200,                // Number (optional)
31            message: "Ok",                  // String (optional)
32            data: result,                   // Object or Array (optional)
33            error: new Error("Ok Example"), // Object (optional)
34        });
35    })
36    .catch((err) => {
37        /*
38        Call res.json and send the following object to the client:
39        {
40            "statusCode": 422,
41            "message": "Unprocessable Entity",
42            "data": {
43                "foo": "bar"
44            },
45            "error": {
46                // Info about your err here
47            }
48        }
49        */
50        UnprocessableEntity.json({
51            res,                            // Response object from express
52            statusCode: 422,                // Number (optional)
53            message: "Unprocessable Entity",// String (optional)
54            data: { foo: "bar" },           // Object or Array (optional)
55            error: err,                     // Object (optional)
56        });
57    });
58});
59
60app.listen(3000);

jsonp

1const express = require("express");
2const app = express();
3const { BadRequest } = require("dotnet-responses");
4
5app.get("/bad-request", function (req, res) {
6    /*
7    Call res.jsonp and send the following object to the client:
8    {
9        "statusCode": 400,
10        "message": "Bad Request",
11        "data": {
12            "foo": "bar"
13        },
14        "error": {
15            // Info about your err here
16        }
17    }
18    */
19    BadRequest.jsonp({
20        res,                                // Response object from express
21        statusCode: 400,                    // Number (optional)
22        message: "Bad Request",             // String (optional)
23        data: { foo: "bar" },               // Object or Array (optional)
24        error: new Error("Bad Request"),    // Object (optional)
25    });
26});
27
28app.listen(3000);

end

1const express = require("express");
2const app = express();
3const { Ok } = require("dotnet-responses");
4
5app.get("/ok", function (req, res) {
6    // Call res.end
7    Ok.end({
8        res,                                // Response object from express
9    });
10});
11
12app.listen(3000);

List of Classes

Format of List

• statusCode: ClassName

100s

• 100: Continue
• 101: SwitchingProtocols
• 102: Processing

200s

• 200: Ok
• 200: Success
• 201: Created
• 202: Accepted
• 203: NonAuthoritativeInformation
• 204: NoContent
• 205: ResetContent
• 206: PartialContent
• 207: MultiStatus
• 208: AlreadyReported
• 226: IMUsed

300s

• 300: MultipleChoices
• 301: MovedPermanently
• 302: Found
• 303: SeeOther
• 304: NotModified
• 305: UseProxy
• 307: TemporaryRedirect
• 308: PermanentRedirect

400s

• 400: BadRequest
• 401: Unauthorized
• 403: Forbidden
• 404: InvalidUrl
• 404: NotFound
• 405: MethodNotAllowed
• 406: NotAcceptable
• 407: ProxyAuthenticationError
• 408: RequestTimeout
• 409: Conflict
• 410: Gone
• 411: LengthRequired
• 412: PreconditionFailed
• 413: RequestEntityTooLarge
• 414: RequestUriTooLong
• 415: UnsupportedMediaType
• 416: RequestedRangeNotSatisfiable
• 417: ExpectationFailed
• 422: UnprocessableEntity
• 422: ValidationError
• 423: Locked
• 424: FailedDependency
• 426: UpgradeRequired
• 428: PreconditionRequired
• 429: TooManyRequests
• 431: RequestHeaderFieldsTooLarge
• 444: NoResponse
• 449: RetryWith
• 451: UnavailableForLegalReasons
• 499: ClientClosedRequest

500s

• 500: InternalServerError
• 501: NotImplemented
• 502: BadGateway
• 503: ServiceUnavailable
• 504: GatewayTimeout
• 505: HttpVersionNotSupported
• 506: VariantAlsoNegotiates
• 507: InsufficientStorage
• 508: LoopDetected
• 509: BandwidthLimitExceeded
• 510: NotExtended
• 511: NetworkAuthenticationRequired
• 598: NetworkReadTimeoutError
• 599: NetworkConnectTimeoutError

Base

• Response

Helper Functions

getResponseByStatusCode

1const { getResponseByStatusCode } = require("dotnet-responses");
2
3const Ok = getResponseByStatusCode(200);
4const UnprocessableEntity = getResponseByStatusCode(422);
5const InternalServerError = getResponseByStatusCode(500);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT