sertonix / typed-regexp

[Moved to Codeberg] Adds type checking for regular expressions.

typed-regexp

A typescript package that strongly restricts types of regular expressions.

Examples

As direct dependency: npm i typed-regexp

import { TypedRegExp } from "typed-regexp";

const regexp = new TypedRegExp<[`{${string}`],{name:"a"|"b"}>("(?<name>[ab])({.*)");
const match = "string to match".match(regexp);
if (match) {
  const namedGroup = match.groups.name;
  // => "a"|"b"
  const group = match[1];
  // => `{${string}`
}

or as dev dependency: npm i -D typed-regexp

import type { TypedRegExp } from "typed-regexp";

const regexp = /(?<name>[ab])({.*)/ as TypedRegExp<[`{${string}`],{name:"a"|"b"}>;
const match = "string to match".match(regexp);
if (match) {
  const namedGroup = match.groups.name;
  // => "a"|"b"
  const group = match[1];
  // => `{${string}`
}

Links

• Codeberg (main repo)
• Github (only mirror)
• npm

typed-regexp's Issues

Target multiple versions

Have support for multiple different versions of ES. This would need multiple .ts files and multiple tsconfig.json files as mentioned here.

move to codeberg.org

There are good reasons to give up github. Therefor I plan on moving to codeberg.org.

Add test script

Add a script that checks that the expected errors are thrown or not.
Maybe use // @ts-expect-error