Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halvardssm/oak-middleware-error-logger
https://github.com/halvardssm/oak-middleware-error-logger
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/halvardssm/oak-middleware-error-logger
- Owner: halvardssm
- License: mit
- Created: 2020-05-25T18:02:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-21T20:11:21.000Z (about 4 years ago)
- Last Synced: 2024-05-08T16:32:57.748Z (4 months ago)
- Language: TypeScript
- Size: 20.5 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Oak Middleware Error & Logging
[](https://github.com/halvardssm/oak-middleware-error-logger/actions?query=branch%3Amaster+workflow%3ACI)
[](https://deno.land)
[](https://github.com/oakserver/oak)
[](https://doc.deno.land/https/raw.githubusercontent.com/halvardssm/oak-middleware-logger/master/mod.ts)
Oak middleware for error handling and logging
## Usage
* As an application middleware
```ts
import { errorHandlerMiddleware } from "https://raw.githubusercontent.com/halvardssm/oak-middleware-error-logger/master/mod.ts"
import { Middleware } from "https://deno.land/x/oak/mod.ts";
const app = new Application();
app.use(
errorHandlerMiddleware({
fallback: async (err, ctx) => {
await logger({ logInfo: err.toString() })
if (isHttpError(err)) {
ctx.throw(err.status, err.message)
} else {
ctx.throw(ErrorStatus.InternalServerError, "Server error")
}
},
})
);
await app.listen(appOptions);
```
* As a router middleware
```ts
import { errorHandlerMiddleware, logger } from "https://raw.githubusercontent.com/halvardssm/oak-middleware-error-logger/master/mod.ts"
import { RouterMiddleware } from "https://deno.land/x/oak/mod.ts";
const app = new Application();
app.use(errorHandlerMiddleware({
fallback: (err, ctx) => {
throw new Error(err as string);
},
cases: {
404: (err, ctx) => someMehod(),
[ErrorStatus.BadRequest]: (err, ctx) => logger({ logInfo: err })
}
}));
await app.listen(appOptions);
```
## Options
ErrorHandler Options
* fallback: errorCallback; // Fallback function for handling all errors which are not handled by the cases
* cases?: Record; // Record of all cases with a callback to handle errors
Logger Options
* logInfo: string | object; // Log text or object
* fileName?: string; // Custom filename, will default to `.log/mm-yyyy.txt` e.g `.log/04-2020.txt`
* prepend?: string; // Custom prepend for log line, will default to iso date e.g. `2020-05-25T17:38:42.483Z: `
* append?: string // Custom append for log line, will default to `\n`
* noEscapeNewLine?: boolean; // Default escapes newline in logInfo, enable this to turn it off
* customFormatting?: (log: string) => string; // Add custom formatting to logInfo
## Contributing
All contributions are welcome, make sure to read the [contributing guidelines](./.github/CONTRIBUTING.md).
## Uses
* [Oak](https://deno.land/x/oak/)