Class VariablePattern

Match or construct a variable name portion.

Remarks

When matching a name, this pattern extracts a number of name components, and saves the sub-name in variables object in VariablePattern.match return value.

When building a name, this pattern succeeds if the variable is present in VariablePattern.build function argument.

Hierarchy (view full)

Constructors

constructor

Properties

filter? id inner? maxComps minComps

Methods

build buildState match matchState simplify buildState matchState

Constructors

constructor

Properties

Optional Readonly filter

filter?: pattern.VariablePattern.Filter

Readonly id

id: string

Variable name.

Optional Readonly inner

inner?: Pattern

Readonly maxComps

maxComps: number

Readonly minComps

minComps: number

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>

    Iterable of possible names.

Protected buildState

match

  • match(name): Iterable<Vars>

  • Determine whether a name matches the structure of this pattern.

    Parameters

    • name: Name

      Input name.

    Returns Iterable<Vars>

    • Iterable of extracted fields in possible interpretations.

Protected matchState

  • matchState(state): Iterable<MatchState>

  • Recognize part of the input name.

    Parameters

    • state: MatchState

    Returns Iterable<MatchState>

    Iterable of potential matches.

simplify

Protected Static buildState

  • buildState(p, state): Iterable<BuildState>

  • Build part of an output name.

    Parameters

    Returns Iterable<BuildState>

    Iterable of potential constructions.

Protected Static matchState

Settings

Member Visibility

Theme

On This Page

constructorfilteridinnermaxCompsminCompsbuildbuildStatematchmatchStatesimplifybuildStatematchState