@lanetix/layout-validator

Schema validation for Lanetix Record Types

Usage no npm install needed!

<script type="module">
  import lanetixLayoutValidator from 'https://cdn.skypack.dev/@lanetix/layout-validator';
</script>

README

layout-validator

Schema validation for Lanetix Layouts

Installation

npm install -S @lanetix/layout-validator

Example Usage

import { group, item, page }  from '@lanetix/layout-validator'

const groupErrors = group({ title: 'cats' })
const pageErrors = page({ title: 'animals' })
const itemErrors = item({ type: 'line-break' }, { layoutType: 'record' })

if any of those errors exist, you have validation errors. null is returned if no errors exist. Also, you can pass { required: 'none' } into group to handle scenarios where no fields are required like PATCHes. Finally, you can optionally the type option into the item validator and it will provide additional validations for certain field types.