Resafe ▪ API Reference

`check(regex, options)`

The primary function that analyzes regex patterns for ReDoS vulnerabilities.

import { check } from "resafe";

const result = check(pattern, options);

// String pattern
check("(a+)+$");

// RegExp object
check(/(a+)+$/);

Property	Type	Default	Description
`threshold`	`number`	`1.0`	Spectral radius threshold for unsafe patterns
`silent`	`boolean`	`false`	Disable console logging
`throwErr`	`boolean`	`false`	Throw error for unsafe patterns

Returns a Result object:

interface Result {
  safe: boolean;     // Whether the pattern is safe
  radius: number;    // Spectral radius value
}

Asynchronous version of check() that returns a Promise. Useful for integration with async workflows.

import { checkAsync } from "resafe";

const result = await checkAsync(pattern, options);

Same as check():

Returns a Promise<Result>:

interface Result {
  safe: boolean;
  radius: number;
}