object-shape-tester/dist/custom-shapes/uuid.shape.d.ts

Test object properties and value types.

import { type Uuid } from '@augment-vir/common';
export { type Uuid } from '@augment-vir/common';
/**
 * 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 declare function uuidShape(defaultValue?: Uuid): import("../shape/shape.js").Shape<import("@sinclair/typebox").TUnsafe<`${string}-${string}-${string}-${string}-${string}`>>;