Class Pattern`Abstract`

Structure of a name.

Hierarchy (View Summary)

Pattern

Index

Constructors

Accessors

matchLengthRange

Methods

build buildState computeMatchLengthRange match matchState buildState matchState

Constructors

constructor

new Pattern(): Pattern
Returns Pattern

Accessors

matchLengthRange

get matchLengthRange(): [min: number, max: number]
Determine minimum and maximum match length.

Returns [min: number, max: number]
Remarks
This optimization is used in match for early rejection of input names that are either too short or too long.
- Defined in schema/pattern.ts:152

Methods

build

build(...varsL: pattern.VarsLike[]): Iterable<Name>
Build names following the structure of this pattern.
Parameters
- ...varsL: pattern.VarsLike[]
  Sets of variables to be replaced into the name.
Returns Iterable<Name>
Iterable of possible names.
- Defined in schema/pattern.ts:165

`Protected` `Abstract`buildState

buildState(state: BuildState): Iterable<BuildState>
Parameters
- state: BuildState
Returns Iterable<BuildState>
- Defined in schema/pattern.ts:187

`Protected` `Abstract`computeMatchLengthRange

computeMatchLengthRange(): [min: number, max: number]
Returns [min: number, max: number]
- Defined in schema/pattern.ts:158

match

match(name: Name): Iterable<pattern.Vars>
Determine whether a name matches the structure of this pattern.
Parameters
- name: Name
  Input name.
Returns Iterable<pattern.Vars>
- Iterable of extracted fields in possible interpretations.
- Defined in schema/pattern.ts:121

`Protected` `Abstract`matchState

matchState(state: MatchState): Iterable<MatchState>
Recognize part of the input name.
Parameters
- state: MatchState
Returns Iterable<MatchState>
Iterable of potential matches.
- Defined in schema/pattern.ts:143

`Protected` `Static`buildState

buildState(p: Pattern, state: BuildState): Iterable<BuildState>
Build part of an output name.
Parameters
- p: Pattern
- state: BuildState
Returns Iterable<BuildState>
Iterable of potential constructions.
- Defined in schema/pattern.ts:183

`Protected` `Static`matchState

matchState(p: Pattern, state: MatchState): Iterable<MatchState>
Parameters
- p: Pattern
- state: MatchState
Returns Iterable<MatchState>
- Defined in schema/pattern.ts:135