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

Test object properties and value types.

import { check } from '@augment-vir/assert';
import { FormatRegistry, Type } from '@sinclair/typebox';
import { defineShape } from '../shape/shape.js';
/**
 * Creates a shape that requires a UUID string.
 *
 * @category Shape
 * @example
 *
 * ```ts
 * import {uuidShape, checkValidShape} from 'object-shape-tester';
 *
 * const myShape = uuidShape();
 *
 * checkValidShape('00000000-0000-1000-0000-000000000000', myShape); // `true`
 * checkValidShape('0-0', myShape); // `false`
 * ```
 */
export function uuidShape(defaultValue = '00000000-0000-1000-0000-000000000000') {
    if (!FormatRegistry.Has('uuid')) {
        FormatRegistry.Set('uuid', (value) => check.isUuid(value));
    }
    return defineShape(Type.Unsafe(Type.String({ format: 'uuid', default: defaultValue })));
}