{"id":13564154,"url":"https://github.com/koajs/error","last_synced_at":"2025-05-16T11:03:44.063Z","repository":{"id":12706986,"uuid":"15379486","full_name":"koajs/error","owner":"koajs","description":"Error response middleware (text, json, html) ","archived":false,"fork":false,"pushed_at":"2025-03-20T03:14:23.000Z","size":48,"stargazers_count":103,"open_issues_count":1,"forks_count":34,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-06T22:08:14.530Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koajs.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-12-22T17:47:54.000Z","updated_at":"2025-03-20T03:14:27.000Z","dependencies_parsed_at":"2025-04-29T05:37:43.735Z","dependency_job_id":null,"html_url":"https://github.com/koajs/error","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koajs%2Ferror","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koajs%2Ferror/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koajs%2Ferror/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koajs%2Ferror/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koajs","download_url":"https://codeload.github.com/koajs/error/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254518383,"owners_count":22084374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:01:27.291Z","updated_at":"2025-05-16T11:03:44.059Z","avatar_url":"https://github.com/koajs.png","language":"JavaScript","readme":"# koa-error\n\nError response middleware for koa supporting:\n\n- [x] text\n- [x] json\n- [x] html\n\n## Installation\n\n```bash\n# npm\n$ npm install koa-error\n# yarn\n$ yarn add koa-error\n```\n\n## Options\n\n- `template` path to template written with your template engine, default: `./error.html`\n- `engine` template engine name passed to [consolidate](https://github.com/ladjs/consolidate), default: `lodash`\n- `cache` cached compiled functions, default: `NODE_ENV != 'development'`\n- `env` force a NODE_ENV, default: `development`\n- `accepts` mimetypes passed to [ctx.accepts](https://github.com/koajs/koa/blob/master/docs/api/request.md#requestacceptstypes), default: `[ 'html', 'text', 'json' ]`\n\n## Custom templates\n\nBy using the `template` option you can override the bland default template,\nwith the following available local variables:\n\n- `env`\n- `ctx`\n- `request`\n- `response`\n- `error`\n- `stack`\n- `status`\n- `code`\n\nHere are some examples:\n\n### Pug (formerly jade)\n\n```js\napp.use(\n  error({\n    engine: \"pug\",\n    template: __dirname + \"/error.pug\",\n  })\n);\n```\n\n```jade\ndoctype html\nhtml\n  head\n    title= 'Error - ' + status\n  body\n    #error\n      h1 Error\n      p Looks like something broke!\n      if env == 'development'\n        h2 Message:\n        pre: code= error\n        h2 Stack:\n        pre: code= stack\n```\n\n### Nunjucks\n\n```js\napp.use(\n  error({\n    engine: \"nunjucks\",\n    template: __dirname + \"/error.njk\",\n  })\n);\n```\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003ctitle\u003eError - {{status}}\u003c/title\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003cdiv id=\"error\"\u003e\n      \u003ch1\u003eError\u003c/h1\u003e\n      \u003cp\u003eLooks like something broke!\u003c/p\u003e\n      {% if env == 'development' %}\n      \u003ch2\u003eMessage:\u003c/h2\u003e\n      \u003cpre\u003e\n          \u003ccode\u003e\n            {{error}}\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003ch2\u003eStack:\u003c/h2\u003e\n      \u003cpre\u003e\n          \u003ccode\u003e\n            {{stack}}\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      {% endif %}\n    \u003c/div\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n#### Custom filters, use macro,block in Nunjucks\n\nkoa-error engine tool base on [consolidate](https://github.com/ladjs/consolidate), you can also set consolidate options\n\n\u003e [more-nunjucks-options](https://github.com/ladjs/consolidate/blob/master/lib/consolidate.js#L1436-L1488) \u003e `app.js`:\n\n```js\n//...\nconst app = new Koa();\nconst nunjucks = require(\"nunjucks\");\nconst nunjucksEnv = new nunjucks.Environment(\n  new nunjucks.FileSystemLoader(path.join(__dirname, \"tpl\"))\n);\n\n// add filters\nconst filters = require(\"./filters\");\nfor (let [k, v] of Object.entries(filters)) {\n  nunjucksEnv.addFilter(k, v);\n}\n\n//...\napp.use(\n  koaError({\n    //...\n    template: path.join(__dirname, \"tpl/error.html\"),\n    options: {\n      nunjucksEnv, // custom nunjucks env\n    },\n  })\n);\n```\n\n`filters.js`:\n\n```js\nmodule.exports = {\n    // define filters function here\n    stringify(..args){\n        return JSON.stringify(...args);\n    }\n    //...\n};\n```\n\n`tpl/error.html`:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n    {% include \"./com.html\" %}\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003cp\u003e{{ request | stringify }}\u003c/p\u003e {# use filters here #}\n    \u003c!-- ... --\u003e\n  \u003c/body\u003e\n\u003c/htm\u003e\n```\n\n`tpl/com.html`:\n\n```html\n\u003clink rel=\"stylesheet\" href=\"/css/normalize.css\" /\u003e\n```\n\n## License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":["JavaScript","Middleware","仓库"],"sub_categories":["中间件"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoajs%2Ferror","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoajs%2Ferror","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoajs%2Ferror/lists"}