Skip to content

Latest commit

 

History

History
60 lines (53 loc) · 1004 Bytes

usage.md

File metadata and controls

60 lines (53 loc) · 1004 Bytes
Raw

Usage

New carol pattern

import carol from 'carol-js';
carol(/[a-z]/);
carol('[a-z]');

Convert to a Regex

import carol from 'carol-js';
carol(/[a-z]/).toRegex();

Pattern sequence

import carol from 'carol-js';
carol.seq([
  carol(/[a-z]/),
  carol(/[0-9]/),
]);

Match any of the patterns

import carol from 'carol-js';
carol.alt([
  carol(/true/),
  carol(/false/),
]);

Repeat pattern

import carol from 'carol-js';
carol(/[a-z]/).many(); // *
carol(/[a-z]/).many(1); // +
carol(/[a-z]/).many(2); // {2,}
carol(/[a-z]/).many(2, 4); // {2,4}
carol(/[a-z]/).many({ length: 2 }); // {2}
carol(/[a-z]/).many({ min: 2, greedy: false }); // {2,}?
carol(/[a-z]/).many({ min: 2, max: 4, greedy: false }); // {2,4}?

Optional pattern

import carol from 'carol-js';
carol(/[a-z]/).option();

Capture input string

import carol from 'carol-js';
carol.seq([
  carol(/[a-z]+/),
  carol(/-/),
  carol(/[0-9]+/).capture(),
]);