Skip to content

Commit 513066e

Browse files
authored
Update README.md
minor changes
1 parent 53ade3d commit 513066e

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ The function signature is:
4444
```typescript
4545
typedRegExp(pattern: string, flags?: string)
4646
```
47+
> Note: `typedRegExp` returns a plain object, **not** a `RegExp` instance.
4748
4849
### Standard RegExp Methods
4950

@@ -64,7 +65,7 @@ pattern.sticky; // false
6465
// ...
6566
```
6667

67-
### Inversed String Methods
68+
### Regex-first Methods
6869

6970
Each `RegExp`-related `string.prototype` method is available as `${MethodName}In` with equivalent or improved typing:
7071

@@ -98,8 +99,6 @@ digitPattern.replaceAllIn('123-456', '#'); // like text.replaceAll(pattern, repl
9899

99100
### Advanced Usage
100101

101-
The `typedRegExp` result is a plain object, **not** a `RegExp` instance.
102-
103102
If you need access to the underlying `RegExp` instance:
104103

105104
```typescript
@@ -121,6 +120,6 @@ const nativeRegExp = pattern.regExp; // Regular RegExp instance
121120

122121

123122
## 📘 API
124-
> ⚠️ **Work in Progress**
123+
> 📋 **Planned**
125124
126125
For now, refer to [Examples PLACEHOLDER](https://www.typescriptlang.org/play?#code/...) or [Usage](#-usage)

0 commit comments

Comments
 (0)