Class AlternatePattern

Specify several alternate patterns in "OR" relation.

Hierarchy (View Summary)

Pattern
- AlternatePattern

Index

Constructors

Properties

Methods

build buildState match matchState simplify buildState matchState

Constructors

constructor

new AlternatePattern(choices?: Pattern[]): AlternatePattern
Parameters
- choices: Pattern[] = []
Returns AlternatePattern
Overrides Pattern.constructor
- Defined in schema/pattern.ts:418

Properties

`Readonly`choices

choices: Pattern[] = []

Methods

build

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

`Protected`buildState

buildState(state: BuildState): Iterable<BuildState, any, any>
Parameters
- state: BuildState
Returns Iterable<BuildState, any, any>
Overrides Pattern.buildState
- Defined in schema/pattern.ts:439

match

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

`Protected`matchState

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

simplify

simplify(): Pattern
Convert to a simpler pattern if possible.

Returns Pattern
Overrides Pattern.simplify
- Defined in schema/pattern.ts:422

`Protected` `Static`buildState

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

`Protected` `Static`matchState

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