data-schema-kenrow-online
v1.0.9
Published
input data-validation
Readme
Sure, here's an updated README.md file for your package:
# data-schema-kenrow-online
This package helps validate payloads.
## Installation
To install the package, use npm:
```sh
npm install data-schema-kenrow-onlineUsage
Here is an example of how to use the data-schema-kenrow-online package to validate payloads:
const data = require("data-schema-kenrow-online");
// Create an object to set all values
const dataValue = {
title: data.dataSchema("string", 10, 30),
body: data.dataSchema("number", 3, 3),
content: data.dataSchema("object"),
};
const createPayload = (req, res) => {
const { title, body, content } = req.body;
// Validate
data.validateSchema(dataValue, { title, body, content });
res.send("Payload is valid");
};API
data.dataSchema(type, min, max)
- type: The data type to validate (e.g., "string", "number", "object").
- min: An optional minimum length or value.
- max: An optional maximum length or value.
data.validateSchema(schema, payload)
- schema: The schema definition to validate against.
- payload: The actual data to validate.
License
This package is licensed under the MIT License.
### Key Changes:
1. **Corrected Markdown Formatting**: Properly closed the code block for the installation command.
2. **Fixed Function Signature in Example**: Corrected the way `dataSchema` is called in the example to pass `min` and `max` as arguments.
3. **Improved Clarity in API Section**: Clearly described the parameters for `data.dataSchema` and `data.validateSchema`.