A collection of response classes that mimic ASP.NET responses
npm install dotnet-responsesA collection of response classes that mimic ASP.NET responses.
![npm][npm-version]
![license][npm-license]
![downloads][npm-downloads]
- 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
``bash`
$ npm install dotnet-responses
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function (req, res) {
/*
Call res.send and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": null,
"error": null
}
*/
const ok = new Ok({ res });
ok.send();
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function (req, res) {
/*
Call res.send and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": null,
"error": null
}
*/
Ok.send({ res });
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const Responses = require("dotnet-responses");app.get("/ok", function (req, res) {
/*
Call res.send and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": null,
"error": null
}
*/
Responses.Ok.send({ res });
/*
Can also do:
const ok = new Responses.Ok({ res });
ok.send();
*/
});
app.listen(3000);
`Constructors
$3
js
const { Ok } = require("dotnet-responses");
new Ok({
res, // Response object from express
message, // String (optional)
data, // Object or Array (optional)
});
`$3
js
const { BadRequest } = require("dotnet-responses");
new BadRequest({
res, // Response object from express
message, // String (optional)
data, // Object or Array (optional)
error, // Object (optional)
});
`$3
js
const { Response } = require("dotnet-responses");
new Response({
statusCode, // Number (optional)
message, // String (optional)
data, // Object or Array (optional)
error, // Object (optional)
});/*
Response has no functions, it just stores the data passed into its constructor
Response's default data:
{
"statusCode": 200,
"message": null,
"data": null,
"error": null
}
*/
`Object Functions
$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function(req, res)
{
// Call res.status to set statusCode to 200
// (This example serves no functional purpose, as Ok has a status code of 200 by default)
const ok = new Ok({ res });
ok.status(
200 // Number
);
ok.send();
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function(req, res)
{
// Call res.sendStatus to send response of "Ok" to client
const ok = new Ok({ res });
ok.sendStatus(
200 // Number
);
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function(req, res)
{
/*
Call res.send and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": null,
"error": null
}
*/
const ok = new Ok({ res });
ok.send(/ No parameters /);
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function(req, res)
{
/*
Call res.json and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": null,
"error": null
}
*/
const ok = new Ok({ res });
ok.json(/ No parameters /);
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function(req, res)
{
/*
Call res.jsonp and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": null,
"error": null
}
*/
const ok = new Ok({ res });
ok.jsonp(/ No parameters /);
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function(req, res)
{
// Call res.end
const ok = new Ok({ res });
ok.end(/ No parameters /);
});
app.listen(3000);
`Static Functions
$3
js
const express = require("express");
const app = express();
const { BadRequest } = require("dotnet-responses");app.get("/bad-request", function(req, res)
{
// Call res.status to set statusCode to 400
// (This example serves no functional purpose, as BadRequest has a status code of 400 by default)
BadRequest.status({
res, // Response object from express
statusCode: 400, // Number (optional)
});
BadRequest.send({ res });
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { BadRequest } = require("dotnet-responses");app.get("/bad-request", function(req, res)
{
// Call res.sendStatus to send response of "Bad Request" to client
BadRequest.sendStatus({
res, // Response object from express
statusCode: 400, // Number (optional)
});
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { NotFound } = require("dotnet-responses");app.get("/*", function(req, res)
{
/*
Call res.send and send the following object to the client:
{
"statusCode": 404,
"message": "Not Found",
"data": {
"foo": "bar"
},
"error": {
// Info about your error here
}
}
*/
NotFound.send({
res, // Response object from express
statusCode: 404, // Number (optional)
message: "Not Found", // String (optional)
data: { foo: "bar" }, // Object or Array (optional)
error: new Error("Page not found"), // Object (optional)
});
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok, UnprocessableEntity } = require("dotnet-responses");const bodyParser = require("body-parser");
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));
const { validateMyPayloadAsync } = require("./some-file-for-custom-validation");
app.post("/validation-error", function(req, res)
{
validateMyPayloadAsync(req.body)
.then((result) => {
/*
Call res.json and send the following object to the client:
{
"statusCode": 200,
"message": "Ok",
"data": {
// Info about result here
},
"error": {
// Info about your error here
}
}
*/
Ok.json({
res, // Response object from express
statusCode: 200, // Number (optional)
message: "Ok", // String (optional)
data: result, // Object or Array (optional)
error: new Error("Ok Example"), // Object (optional)
});
})
.catch((err) => {
/*
Call res.json and send the following object to the client:
{
"statusCode": 422,
"message": "Unprocessable Entity",
"data": {
"foo": "bar"
},
"error": {
// Info about your err here
}
}
*/
UnprocessableEntity.json({
res, // Response object from express
statusCode: 422, // Number (optional)
message: "Unprocessable Entity",// String (optional)
data: { foo: "bar" }, // Object or Array (optional)
error: err, // Object (optional)
});
});
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { BadRequest } = require("dotnet-responses");app.get("/bad-request", function (req, res) {
/*
Call res.jsonp and send the following object to the client:
{
"statusCode": 400,
"message": "Bad Request",
"data": {
"foo": "bar"
},
"error": {
// Info about your err here
}
}
*/
BadRequest.jsonp({
res, // Response object from express
statusCode: 400, // Number (optional)
message: "Bad Request", // String (optional)
data: { foo: "bar" }, // Object or Array (optional)
error: new Error("Bad Request"), // Object (optional)
});
});
app.listen(3000);
`$3
js
const express = require("express");
const app = express();
const { Ok } = require("dotnet-responses");app.get("/ok", function (req, res) {
// Call res.end
Ok.end({
res, // Response object from express
});
});
app.listen(3000);
`List of Classes
$3
- statusCode: $3
- 100:
- 101:
- 102: $3
- 200:
- 200:
- 201:
- 202:
- 203:
- 204:
- 205:
- 206:
- 207:
- 208:
- 226: $3
- 300:
- 301:
- 302:
- 303:
- 304:
- 305:
- 307:
- 308: $3
- 400:
- 401:
- 403:
- 404:
- 404:
- 405:
- 406:
- 407:
- 408:
- 409:
- 410:
- 411:
- 412:
- 413:
- 414:
- 415:
- 416:
- 417:
- 422:
- 422:
- 423:
- 424:
- 426:
- 428:
- 429:
- 431:
- 444:
- 449:
- 451:
- 499: $3
- 500:
- 501:
- 502:
- 503:
- 504:
- 505:
- 506:
- 507:
- 508:
- 509:
- 510:
- 511:
- 598:
- 599: $3
- Helper Functions
$3
js
const { getResponseByStatusCode } = require("dotnet-responses");const Ok = getResponseByStatusCode(200);
const UnprocessableEntity = getResponseByStatusCode(422);
const InternalServerError = getResponseByStatusCode(500);
``Please make sure to update tests as appropriate.
[npm-version]: https://img.shields.io/npm/v/dotnet-responses
[npm-license]: https://img.shields.io/npm/l/dotnet-responses
[npm-downloads]: https://img.shields.io/npm/dm/dotnet-responses