import TryIt from '../../../components/TryIt.jsx';
export const tryItCode = "console.log(isUUID('f47ac10b-58cc-4372-a567-0e02b2c3d479')); //=> true\nconsole.log(isUUID('not-a-uuid')); //=> false\nconsole.log(isUUID(42)); //=> false";
import { Callout } from "@opentf/afw-docs";
export const metadata = {
title: "isUUID — Crypto",
description: "Checks whether a value is a UUID string in any of the standard variants (v1–v8), including the nil and max forms."
};
# isUUID
🆔 Checks whether a value is a UUID.
The counterpart to [uuidv4](/docs/Crypto/uuidv4) and
[uuidv7](/docs/Crypto/uuidv7), and the more common operation of the two: an
identifier arriving from a route parameter, a form or another service has to be
checked before it is trusted.
A bare `8-4-4-4-12` hex test is not that check. It admits strings no generator
produces, because it ignores the version and variant bits the format reserves.
## Syntax
```ts
import { isUUID } from '@opentf/std';
isUUID(val: unknown, version?: number): val is string;
```
## Parameters
| Name | Type | Default | Description |
| ------- | --------- | ------- | --------------------------------- |
| val | `unknown` | | The value to check. |
| version | `number` | | Require this exact version, 1–8. |
## Returns
`true` if the value is a UUID. Throws a `RangeError` if `version` is given and
is not an integer from 1 to 8.
Versions 1 to 8 are recognised, following **RFC 9562** rather than the older RFC
4122 — this module emits version 7, which RFC 4122 has no concept of, so the
narrower rule would reject its own output.
Case-insensitive, as the specification requires. Hyphens must be present and in
place: a bare 32-character hex string is not a UUID.
## Examples
```ts
isUUID('f47ac10b-58cc-4372-a567-0e02b2c3d479') //=> true
isUUID('not-a-uuid') //=> false
isUUID(42) //=> false
```
Pinning the version:
```ts
isUUID(uuidv7(), 7) //=> true
isUUID(uuidv4(), 7) //=> false
```
## The Nil and Max UUIDs
Both are accepted as the special forms RFC 9562 defines. Neither carries a
version, so neither satisfies a `version` filter:
```ts
isUUID('00000000-0000-0000-0000-000000000000') //=> true
isUUID('ffffffff-ffff-ffff-ffff-ffffffffffff') //=> true
isUUID('00000000-0000-0000-0000-000000000000', 4) //=> false
```
## Related
- [uuidv7Time](/docs/Crypto/uuidv7Time)
- [uuidv4](/docs/Crypto/uuidv4)
- [uuidv7](/docs/Crypto/uuidv7)
- [isULID](/docs/Crypto/isULID)
## Try it