@codibly/api-validation

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](ht

Usage no npm install needed!

<script type="module">
  import codiblyApiValidation from 'https://cdn.skypack.dev/@codibly/api-validation';
</script>

README

@codibly/api-validation

semantic-release code style: prettier commitizen friendly tested with jest

npm version npm license npm downloads npm types

Installation

This package is available as an npm package.

npm install --save @codibly/api-validation

or

yarn add @codibly/api-validation

Usage

The main gola of this library is to help is easy way handle api validation.

Error Code

  • VALIDATION_ERROR - validation form error code

    Check error code

    To check if error has valid error code we use function isError
function isError(ErrorCode, Response | undefined): error is Error {}

Get form errors

To get validation form errors we have to functions which reducer array of errors to simple object where key is a filed name and value is a string or object.

- ValidationErrorMapper.toFormError(error: Error): FormError
- ValidationErrorMapper.toFormErrorsWithSheetCells(error: Error, sheetField: string[]): FormError

License

MIT