Class Pattern

constructor

• new Pattern(path?, options?): Pattern

• Parameters

  • Optional path: string

  • options: {
        constraints?: PlaceholderTypes;
        defaults?: Record<string, any>;
        types?: PlaceholderTypes;
    } = {}

    • Optional constraints?: PlaceholderTypes

    • Optional defaults?: Record<string, any>

    • Optional types?: PlaceholderTypes

  Returns Pattern

_ast

constraints

defaults

placeholders

regex

types

unparsed

_compile

• _compile(withExtension): RegExp

• Parameters

  • withExtension: boolean

  Returns RegExp

_compileExtension

• _compileExtension(ext, withDefault): string

• Parameters

  • ext: PlaceholderType

  • withDefault: boolean

  Returns string

_compileType

• _compileType(type): string

• Parameters

  • type: PlaceholderType

  Returns string

_tokenize

• _tokenize(): void

• Returns void

match

• match(path, options): null | Record<string, any>

• Match pattern against entire path.

  Parameters

  • path: string

  • options: MatchOptions

  Returns null | Record<string, any>

matchPartial

• matchPartial(path, options): null | Record<string, any> & {
      remainder: string;
  }

• Match pattern against path and return the remainder.

  Parameters

  • path: string

  • options: MatchOptions

  Returns null | Record<string, any> & {
      remainder: string;
  }

parse

• parse(path?): Pattern

• Parse pattern.

  Parameters

  • path: string = ''

  Returns Pattern

render

• render(values, options): string

• Render pattern into a path with parameters.

  Parameters

  • values: Record<string, string>

  • options: MatchOptions

  Returns string