Skip to content

Match

Defined in: packages/pythonlib/src/re.ts:39

Constructors

Constructor

new Match(match: RegExpExecArray, string: string, pattern: Pattern, pos: number, endpos?: number): Match

Defined in: packages/pythonlib/src/re.ts:46

Parameters

ParameterTypeDefault value
matchRegExpExecArrayundefined
stringstringundefined
patternPatternundefined
posnumber0
endpos?numberundefined

Returns

Match

Accessors

endpos

Get Signature

get endpos(): number

Defined in: packages/pythonlib/src/re.ts:115

Return end position of search

Returns

number


lastGroup

Get Signature

get lastGroup(): string | undefined

Defined in: packages/pythonlib/src/re.ts:128

Return the name of the last matched group

Returns

string | undefined


lastIndex

Get Signature

get lastIndex(): number | undefined

Defined in: packages/pythonlib/src/re.ts:120

Return the last matched group index

Returns

number | undefined


pos

Get Signature

get pos(): number

Defined in: packages/pythonlib/src/re.ts:110

Return start position of search

Returns

number


re

Get Signature

get re(): Pattern

Defined in: packages/pythonlib/src/re.ts:142

Return the pattern object

Returns

Pattern


string

Get Signature

get string(): string

Defined in: packages/pythonlib/src/re.ts:147

Return the input string

Returns

string

Methods

[iterator]()

[iterator](): Generator<string | undefined>

Defined in: packages/pythonlib/src/re.ts:162

Return iterator of all groups

Returns

Generator<string | undefined>


end()

end(groupNum: number): number

Defined in: packages/pythonlib/src/re.ts:97

Return the end index of the match

Parameters

ParameterTypeDefault value
groupNumnumber0

Returns

number


expand()

expand(template: string): string

Defined in: packages/pythonlib/src/re.ts:152

Expand template with groups

Parameters

ParameterType
templatestring

Returns

string


group()

group(groupNum: string | number): string | undefined

Defined in: packages/pythonlib/src/re.ts:55

Return the string matched by the RE

Parameters

ParameterTypeDefault value
groupNumstring | number0

Returns

string | undefined


groupDict()

groupDict(defaultValue?: string): Record<string, string | undefined>

Defined in: packages/pythonlib/src/re.ts:73

Return a dictionary of named groups

Parameters

ParameterType
defaultValue?string

Returns

Record<string, string | undefined>


groups()

groups(defaultValue?: string): (string | undefined)[]

Defined in: packages/pythonlib/src/re.ts:64

Return a tuple containing all subgroups

Parameters

ParameterType
defaultValue?string

Returns

(string | undefined)[]


span()

span(groupNum: number): [number, number]

Defined in: packages/pythonlib/src/re.ts:105

Return a tuple (start, end)

Parameters

ParameterTypeDefault value
groupNumnumber0

Returns

[number, number]


start()

start(groupNum: number): number

Defined in: packages/pythonlib/src/re.ts:84

Return the start index of the match

Parameters

ParameterTypeDefault value
groupNumnumber0

Returns

number


toString()

toString(): string

Defined in: packages/pythonlib/src/re.ts:168

Returns

string