Skip to content

Commit 6af9c4c

Browse files
chore: Clarify purpose of character class types in documentation (#122)
1 parent 72e9b5a commit 6af9c4c

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/ast.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,12 +197,23 @@ interface BaseCharacterClass extends NodeBase {
197197
negate: boolean
198198
elements: CharacterClassElement[]
199199
}
200+
/**
201+
* The character class used in legacy (neither `u` nor `v` flag) and Unicode mode (`u` flag).
202+
*
203+
* This character class is guaranteed to **not** contain strings.
204+
*
205+
* In Unicode sets mode (`v` flag), {@link UnicodeSetsCharacterClass} is used.
206+
*/
200207
export interface ClassRangesCharacterClass extends BaseCharacterClass {
201208
parent: Alternative | Quantifier
202209
unicodeSets: false
203210
elements: ClassRangesCharacterClassElement[]
204211
}
205-
/** UnicodeSetsCharacterClass is the CharacterClass when in Unicode sets mode. So it may contain strings. */
212+
/**
213+
* The character class used in Unicode sets mode (`v` flag).
214+
*
215+
* This character class may contain strings.
216+
*/
206217
export interface UnicodeSetsCharacterClass extends BaseCharacterClass {
207218
parent:
208219
| Alternative

0 commit comments

Comments
 (0)