object-shape-tester/dist/custom-shapes/tuple.shape.js

Test object properties and value types.

import { Type } from '@sinclair/typebox';
import { defineShape } from '../shape/shape.js';
/**
 * Creates a shape that requires a tuple.
 *
 * @category Shape
 * @example
 *
 * ```ts
 * import {tupleShape, checkValidShape} from 'object-shape-tester';
 *
 * const myShape = tupleShape('', -1);
 *
 * checkValidShape(
 *     [
 *         'a',
 *         10,
 *     ],
 *     myShape,
 * ); // `true`
 * checkValidShape(
 *     [
 *         'a',
 *     ],
 *     myShape,
 * ); // `false`
 * ```
 */
export function tupleShape(...tupleParts) {
    const defaultValue = [];
    const schemas = [];
    tupleParts.forEach((part) => {
        const shape = defineShape(part);
        defaultValue.push(shape.default);
        schemas.push(shape.$_schema);
    });
    return defineShape(Type.Tuple(schemas, {
        default: defaultValue,
    }));
}