Represents a regular expression type in Firestore documents.

RegexValue

**Signature:**

    export declare class RegexValue 

## Constructors

| Constructor | Modifiers | Description |
|---|---|---|
| [(constructor)(pattern, options)](https://firebase.google.com/docs/reference/js/firestore.regexvalue#regexvalueconstructor) |   | Constructs a new instance of the `RegexValue` class |

## Properties

| Property | Modifiers | Type | Description |
|---|---|---|---|
| [options](https://firebase.google.com/docs/reference/js/firestore.regexvalue#regexvalueoptions) |   | string |   |
| [pattern](https://firebase.google.com/docs/reference/js/firestore.regexvalue#regexvaluepattern) |   | string |   |

## Methods

| Method | Modifiers | Description |
|---|---|---|
| [isEqual(other)](https://firebase.google.com/docs/reference/js/firestore.regexvalue#regexvalueisequal) |   | Returns true if this `RegexValue` is equal to the provided one. |

## RegexValue.(constructor)

Constructs a new instance of the `RegexValue` class

**Signature:**

    constructor(pattern: string, options: string);

#### Parameters

| Parameter | Type | Description |
|---|---|---|
| pattern | string |   |
| options | string |   |

## RegexValue.options

**Signature:**

    readonly options: string;

## RegexValue.pattern

**Signature:**

    readonly pattern: string;

## RegexValue.isEqual()

Returns true if this `RegexValue` is equal to the provided one.

**Signature:**

    isEqual(other: RegexValue): boolean;

#### Parameters

| Parameter | Type | Description |
|---|---|---|
| other | [RegexValue](https://firebase.google.com/docs/reference/js/firestore.regexvalue#regexvalue_class) | The `RegexValue` to compare against. 'true' if this `RegexValue` is equal to the provided one. |

**Returns:**

boolean