Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halvardssm/oak-middleware-validator
https://github.com/halvardssm/oak-middleware-validator
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/halvardssm/oak-middleware-validator
- Owner: halvardssm
- License: mit
- Created: 2020-06-01T09:32:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-21T20:01:20.000Z (over 4 years ago)
- Last Synced: 2024-10-04T17:23:38.795Z (about 1 month ago)
- Language: TypeScript
- Size: 23.4 KB
- Stars: 7
- 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 Validator
[](https://github.com/halvardssm/oak-middleware-validator/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-validator/master/mod.ts)
Oak middleware for parameter and body validator
## Usage
* As a router middleware
```ts
import { validatorMiddleware, ValidatorMiddlewareOptions } from "https://raw.githubusercontent.com/halvardssm/oak-middleware-validator/master/mod.ts"
import { RouterMiddleware } from "https://deno.land/x/oak/mod.ts";
const router = new Router();
const app = new Application();
const options: ValidatorMiddlewareOptions = {
validations: [
{ key: "a", validationOption: "string", isUrlParam: true },
{ key: "b", validationOption: "b", isOptional: true },
{ key: "c", validationOption: validateStringIn("b") },
{ key: "d", validationOption: validateIsNumber(0, 1) },
],
bodyRequired: true,
errorMessages: {
ERROR_NO_BODY: "Custom message"
}
}
router
.get("/bar", validatorMiddleware(options),...)
app.use(router.routes());
await app.listen(appOptions);
```
## Options
* validations: ValidationT[]; // Array of validations
* bodyRequired?: boolean; // If true, will return error if body is empty
* bodyType?: BodyType; // Will validate the body against a provided body type
* errorMessages?: Partial; // Customize your own error messages
### validationT
* key: string; // The key
* validationOption: ValidationFn | string; // The validation function, also accepts a `typeof` or a string to compare strings
* isOptional?: boolean; // Will allow the key to be missing
* isUrlParam?: boolean; // Will check the url instead of the body
### errorMessagesT
* ERROR_NO_BODY: "No body was provided",
* ERROR_INVALID_BODY: "Invalid body type",
* ERROR_MISSING_REQUIRED: "No value was provided",
* ERROR_VALIDATION_FAILED: "Validation failed",
* ERROR_NOT_IN_ARRAY: "Value not in array",
* ERROR_NUMBER_MIN: "Value is smaller than the allowed size",
* ERROR_NUMBER_MAX: "Value is larger than the allowed size"
### validationFn
``` ts
(
key: string, // The key
value: string | Uint8Array, // The value
validationError: ValidationErrorFn, // The validation error callback
errorMessages: ErrorMessagesT, // Exposes the error messages
options: ValidatorMiddlewareOptions // Exposes the options
) => void
```
## Available validation methods
* `validateStringInArray(...values: string[])` // Checks if the value is in the array
* `validateIsNumber(min?: number, max?: number, radix?: number)` // Checks if the value is a number, and if min/max is given it compares them inclusively
## Contributing
All contributions are welcome, make sure to read the [contributing guidelines](./.github/CONTRIBUTING.md).
## Uses
* [Oak](https://deno.land/x/oak/)