SCHEMA
Validation Methods
.oneOf

Schema - OneOf

The .oneOf method is used to validate whether a given value matches one of several specified values or schemas. It ensures that the input value must match at least one of the provided values or schemas in the array. This method is essential when you need to validate data that can be one of several possibilities, such as matching any of a few predefined values or structures.


Example: Basic Validation with .oneOf

Below is an example of how to use .oneOf to validate whether a value matches any of the comparison values or schemas:

import { schema } from "vkrun"
 
// Comparison items can include static values and schemas
const comparisonItems = ["hello", "world", schema().boolean()]
const exampleSchema = schema().oneOf(comparisonItems)
 
// Validate against the schema
const validateA = exampleSchema.validate("hello") // Matches "hello"
const validateB = exampleSchema.validate(false)   // Matches schema().boolean()
const validateC = exampleSchema.validate("hi")    // No match
 
console.log(validateA) // true
console.log(validateB) // true
console.log(validateC) // false
Copyright © 2024 MIT by Mario Elvio