# isRegexMatch

```typescript
isRegexMatch(regex)
```

Verifies if provided `Verificable` represents a string that matches provided `regex` object.

### Arguments:

* `regex` - required, of type `RegExp` 

### Possible errors:

#### If provided `Verificable` is not a string:

```typescript
{
    type: "isString",
    path: [/* ... */]
}
```

#### If provided `Verificable` is not matching provided `regex`:

```typescript
{
    type: "isRegexMatch",
    path: [/* ... */]
}
```

### Examples:

Each of examples uses this import statement:

```typescript
const { asVerificable, isValid, isRegexMatch } = require("verifica");
```

#### Null or undefined is not considered a string:

```typescript
const verificable = asVerificable(null);
isValid(verificable, isRegexMatch(/^[0-9]*$/)); // false
```

#### Number value is not considered a string as well:

```typescript
const verificable = asVerificable(123);
isValid(verificable, isRegexMatch(/^[0-9]*$/)); // false
```

#### Value not matching the `regex` is not matching the predicate:

```typescript
const verificable = asVerificable("abc");
isValid(verificable, isRegexMatch(/^[0-9]*$/)); // false
```

#### Value matching the `regex` matches the predicate:

```typescript
const verificable = asVerificable("123");
isValid(verificable, isRegexMatch(/^[0-9]*$/)); // true
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://radoslaw-medryk.gitbook.io/verifica/predicates/built-in-predicates/isregexmatch.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.