phantom-marmiton/docs/modules/marmiton_validate.md
2022-01-08 00:55:27 +01:00

48 lines
841 B
Markdown

[phantom-exo](../README.md) / [Modules](../modules.md) / marmiton/validate
# Module: marmiton/validate
## Table of contents
### Variables
- [jsonSchema](marmiton_validate.md#jsonschema)
### Functions
- [validateMarmitonSearchInput](marmiton_validate.md#validatemarmitonsearchinput)
## Variables
### jsonSchema
**jsonSchema**: `any`
#### Defined in
marmiton/validate.ts:3
## Functions
### validateMarmitonSearchInput
**validateMarmitonSearchInput**(`value`): value is MarmitonSearchInput
validate value against json schema defined into input.json file
#### Parameters
| Name | Type | Description |
| :------ | :-------- | :------------- |
| `value` | `unknown` | value to check |
#### Returns
value is MarmitonSearchInput
true if value is valid false otherwise
#### Defined in
marmiton/validate.ts:12