@finch/regexp-accept v1.0.8

:books: All guides and package documentation.

@finch/regexp-accept

:bird: Stability: 2 - Stable (added in 1.0.0)

Conditional operator that only yields the value it was provided when the value matches its regular expression pattern.

Regular expressions are capable of matching an enormous variety of conditions. Tools like regexr.com are an excellent resource for regular expression learing an testing.

Related: @finch/regexp-ignore

Installation

npm install -g @finch/regexp-accept

:bird: Omit -g flag to install within the current directory.

Params

• pattern: a regular expression used to test the string value.

Examples

Accept any value which contains the characters rail; case insensitive:

{ "use": "@finch/regexp-accept", "params": { "pattern": "/rail/i" } }

:bird: Regular expressions match characters. The /rail/i expression will match frail, grails, Braille, etc.

Accept any value which contains the word rail; case insensitive

{ "use": "@finch/regexp-accept", "params": { "pattern": "/\\brail\\b/i" } }

Accept any value which is precisely Hello World:

{ "use": "@finch/regexp-accept", "params": { "pattern": "/^Hello World$/" } }

Accept any value which contains the words hello or world; case insensitive:

{
  "use": "@finch/regexp-accept",
  "params": { "pattern": "/\\b(hello|world)\\b/i" }
}

:bird: Case insensitive matches are useful to focus on the characters and words while ignoring their presentation.

Sometimes it's hard to get your head around a complicated pattern. Not to mention that a pattern can be quite long. Solving both issues are the any and all parameters. Each parameter accepts an array of regular expressions.

The any usage below breaks /\\b(hello|world)\\b/i into two smaller patterns. A value which matches at least one of the patterns is accepted.

{
  "use": "@finch/regexp-accept",
  "params": { "any": ["/\\bhello\\b/i", "/\\bworld\\b/i"] }
}

The all operator works similarly. A value which matches each of the patterns is accepted.

{
  "use": "@finch/regexp-accept",
  "params": { "all": ["/\\bhello\\b/i", "/\\bworld\\b/i"] }
}

They can even be used together. A value must match each of the all operators and at least one of the any patterns.

{
  "use": "@finch/regexp-accept",
  "params": {
    "all": ["/\\bhello\\b/i", "/\\bworld\\b/i"],
    "any": ["/\\bcat\\b/", "/\\bdog\\b/"]
  }
}

:bird: