Class RegExpCoder

Regular Expression Coder

see: Regular Expressions

Hierarchy

RegExpCoder

Index

Constructors

constructor

Accessors

source

Constructors

constructor

new RegExpCoder(): RegExpCoder

Returns RegExpCoder

Accessors

source

get source(): string

- Defined in regExpCoder.ts:571
Get source

Returns string

Methods

beginGroup

beginGroup(name?: string): RegExpCoder

- Defined in regExpCoder.ts:517
(?<name>:.. Begin a group

Parameters
- Optional name: string
  
  the group name
Returns RegExpCoder

clear

clear(keepDefinitions?: boolean): RegExpCoder

- Defined in regExpCoder.ts:547
Clear the content

Parameters
- keepDefinitions: boolean = false
  
  if keep the definitions
Returns RegExpCoder

define

define(name: string, ...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:244
xy Define a variable

Parameters
- name: string
  
  the variable name
- Rest ...exp: RegExpParam[]
  
  the variable expression
Returns RegExpCoder

defineGroup

defineGroup(name: string, ...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:256
(xy) Define a variable for group operation

Parameters
- name: string
  
  the variable name
- Rest ...exp: RegExpParam[]
  
  the variable expression
Returns RegExpCoder

defineLookahead

defineLookahead(name: string, exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:307
x(?=y) Define a lookahead variable

Parameters
- name: string
  
  the variable name
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

defineLookbehind

defineLookbehind(name: string, exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:345
(?<=y)x Define a lookbehind variable

Parameters
- name: string
  
  the variable name
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

defineNegatedLookahead

defineNegatedLookahead(name: string, exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:326
x(?!y) Define a negated lookahead variable

Parameters
- name: string
  
  the variable name
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

defineNegatedLookbehind

defineNegatedLookbehind(name: string, exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:364
(?<!y)x Define a negated lookbehind variable

Parameters
- name: string
  
  the variable name
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

defineNegatedSet

defineNegatedSet(name: string, ...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:292
[^xy] Define a variable for negated set

Parameters
- name: string
  
  the variable name
- Rest ...exp: RegExpParam[]
  
  the variable expression
Returns RegExpCoder

defineOr

defineOr(name: string, ...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:268
x|y Define a variable for or operation

Parameters
- name: string
  
  the variable name
- Rest ...exp: RegExpParam[]
  
  the variable expression
Returns RegExpCoder

defineSet

defineSet(name: string, ...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:280
[xy] Define a variable for set

Parameters
- name: string
  
  the variable name
- Rest ...exp: RegExpParam[]
  
  the variable expression
Returns RegExpCoder

enableMatchWhole

enableMatchWhole(): RegExpCoder

- Defined in regExpCoder.ts:538
Enable match whole

Returns RegExpCoder

endGroup

endGroup(name?: string): RegExpCoder

- Defined in regExpCoder.ts:527
).. End a group

Parameters
- Optional name: string
  
  the group name
Returns RegExpCoder

group

group(...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:401
(xy) Append an expression for or operation

Parameters
- Rest ...exp: RegExpParam[]
  
  the expression
Returns RegExpCoder

join

join(...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:390
xy Append an expression

Parameters
- Rest ...exp: RegExpParam[]
  
  the expression
Returns RegExpCoder

lookahead

lookahead(exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:447
x(?=y) Append a lookahead expression

Parameters
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

lookbehind

lookbehind(exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:483
(?<=y)x Append a lookbehind expression

Parameters
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

negatedLookahead

negatedLookahead(exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:465
x(?!y) Append a negated lookahead expression

Parameters
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

negatedLookbehind

negatedLookbehind(exp: string | RegExp | RegExpCoder, exp2: string | RegExp | RegExpCoder, options?: RegExpOptions): RegExpCoder

- Defined in regExpCoder.ts:501
(?<!y)x Append a negated lookbehind expression.

Parameters
- exp: string | RegExp | RegExpCoder
  
  the variable expression
- exp2: string | RegExp | RegExpCoder
  
  the variable expression
- Optional options: RegExpOptions
  
  the build options
Returns RegExpCoder

negatedSet

negatedSet(...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:434
[^xy] Append an expression for negated set

Parameters
- Rest ...exp: RegExpParam[]
  
  the expression
Returns RegExpCoder

or

or(...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:412
x|y Append an expression for or operation

Parameters
- Rest ...exp: RegExpParam[]
  
  the expression
Returns RegExpCoder

set

set(...exp: RegExpParam[]): RegExpCoder

- Defined in regExpCoder.ts:423
[xy] Append an expression for set

Parameters
- Rest ...exp: RegExpParam[]
  
  the expression
Returns RegExpCoder

stash

stash(name: string): RegExpCoder

- Defined in regExpCoder.ts:379
Stash the current expression as a variable.

Parameters
- name: string
  
  the variable name
Returns RegExpCoder

toRegExp

toRegExp(flags?: string): RegExp

- Defined in regExpCoder.ts:560
Get the build result

Parameters
- Optional flags: string
  
  flags
Returns RegExp

Static encodeRegExp

encodeRegExp(raw: string, forSet?: boolean): string

- Defined in regExpCoder.ts:213
Encode a raw string to a regular expression string. Following special characters will be encoded: ^\.()[]?+*|$

For set case, encoded characters: ^\-] Rules:
- escape ^ only when it is the first char
- escape - only when it is not the first char and not the last char
- escaped \] always
Parameters
- raw: string
  
  the raw string
- forSet: boolean = false
  
  if for set [] operation
Returns string

Static new

new(): RegExpCoder

- Defined in regExpCoder.ts:59
Create an instance of RegExpCoder

Returns RegExpCoder

Generated using TypeDoc