Skip to main content

​
Installation

Bitaboom is available on npm and can be installed using any modern JavaScript package manager.

​
Choose your package manager

npm install bitaboom

​
Requirements

Bitaboom requires the following minimum versions:
  • Node.js: 24.0.0 or higher
  • Bun: 1.3.8 or higher (if using Bun)
The project targets ESNext and all exports are tree-shakeable, so modern bundlers will only include the functions you actually use.

​
Verify installation

After installation, verify that Bitaboom is working correctly by running a simple test: 
import { makeDiacriticInsensitiveRegex } from 'bitaboom';

const rx = makeDiacriticInsensitiveRegex('أنا');
console.log(rx.test('انا')); // true
If this outputs true, you’re ready to start using Bitaboom!

​
TypeScript support

Bitaboom is written in TypeScript and includes full type definitions out of the box. No additional @types package is required. 
import type { MakeRegexOptions } from 'bitaboom';

const options: MakeRegexOptions = {
  ignoreDiacritics: true,
  allowTatweel: true,
  flexWhitespace: true
};

​
Next steps

Quickstart

Learn the basics with working code examples

Build docs developers (and LLMs) love

Get started for freeTalk to us