Class Pattern`Abstract`

Structure of a name.

Hierarchy

Pattern

Index

Constructors

Methods

build buildState match matchState simplify buildState matchState

Constructors

constructor

new Pattern(): Pattern
Returns Pattern

Methods

build

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

`Protected` `Abstract` buildState

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

match

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

`Protected` `Abstract` matchState

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

simplify

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

Returns Pattern
- Defined in schema/pattern.ts:85

`Protected` `Static` buildState

buildState(p, state): 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:138

`Protected` `Static` matchState

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

Generated using TypeDoc