# codePoints

> This document is the Markdown version of [valibot.dev/api/codePoints/](https://valibot.dev/api/codePoints/). For the complete documentation index, see [llms.txt](https://valibot.dev/llms.txt).

Creates a [code points](https://developer.mozilla.org/en-US/docs/Glossary/Code_point) validation action.

```ts
const Action = v.codePoints<TInput, TRequirement, TMessage>(
  requirement,
  message
);
```

## Generics

- `TInput` `extends string`
- `TRequirement` `extends number`
- `TMessage` `extends ErrorMessage<CodePointsIssue<TInput, TRequirement>> | undefined`

## Parameters

- `requirement` `TRequirement`
- `message` `TMessage`

### Explanation

With `codePoints` you can validate the number of Unicode code points in a string. Code points are not the same as UTF-16 code units or user-perceived characters (graphemes): `😀` consists of 2 UTF-16 code units, 1 code point, and 1 grapheme, while `👨🏽‍👩🏽` consists of 5 code points but 1 grapheme. If the number of code points does not match the `requirement`, you can use `message` to customize the error message.

## Returns

- `Action` `CodePointsAction<TInput, TRequirement, TMessage>`

## Examples

The following examples show how `codePoints` can be used.

### Code points schema

Schema to validate a string with 8 code points.

```ts
const CodePointsSchema = v.pipe(
  v.string(),
  v.codePoints(8, 'Exactly 8 code points are required.')
);
```

## Related

The following APIs can be combined with `codePoints`.

### Schemas

[`any`](/api/any.md), [`custom`](/api/custom.md), [`string`](/api/string.md)

### Methods

[`pipe`](/api/pipe.md)

### Actions

[`graphemes`](/api/graphemes.md), [`length`](/api/length.md)

### Utils

[`isOfKind`](/api/isOfKind.md), [`isOfType`](/api/isOfType.md)