Add CoreValidationSchema online documentation

plus validation module docs
This commit is contained in:
JeremyStar™ 2024-05-05 15:02:59 +02:00
parent 640b8ce6a2
commit 206a6220cc
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
4 changed files with 28 additions and 2 deletions

View file

@ -25,6 +25,7 @@ Use these to access CORE's modules.
- [`sms`](/reference/sms) - [`sms`](/reference/sms)
- [`erm`](/reference/erm) (formerly `edl`) - [`erm`](/reference/erm) (formerly `edl`)
- [`storage`](/reference/storage) - [`storage`](/reference/storage)
- [`validation`](/reference/validation)
## Constants ## Constants
### *Array[String]* <u>modules</u> = *[ "logger", "misc", "sms", "logui", "erm", "storage" ]* ### *Array[String]* <u>modules</u> = *[ "logger", "misc", "sms", "logui", "erm", "storage" ]*

View file

@ -0,0 +1,13 @@
---
sidebar_position: 10
description: Allows for data validation.
---
# `Validation (module)`
## Functions
### *CoreValidationSingle* <u>get_single</u>(*anything you like* <u>data</u>, *Node* <u>parent</u>)
Returns a new [`CoreValidationSingle`](/reference/validationsingle).
### *CoreValidationSchema* <u>get_schema</u>(*Dictionary* <u>schema</u>, *Node* <u>parent</u>)
Returns a new [`CoreValidationSchema`](/reference/validationschema).

View file

@ -0,0 +1,12 @@
---
sidebar_position: 12
description: Used for validating multiple CoreValidationSingles.
---
# `CoreValidationSchema`
Validates multiple `CoreValidationSingle`s at once.
## Functions
### *Array[String]* <u>evaluate</u>()
Evaluates all singles and returns the names of all failed singles in an array.

View file

@ -1,10 +1,10 @@
--- ---
sidebar_position: 10 sidebar_position: 11
description: Used for validating data. description: Used for validating data.
--- ---
# `CoreValidationSingle` # `CoreValidationSingle`
Provides the default configuration for the CORE Framework. Validates some data against a set of predefined rules.
## Variables ## Variables