Class Pattern

constructor

• new Pattern(
      path?: string,
      options?: {
          constraints?: PlaceholderTypes;
          defaults?: Record<string, any>;
          types?: PlaceholderTypes;
      },
  ): Pattern

  Parameters

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

  Returns Pattern

_ast

constraints

defaults

placeholders

regex

types

unparsed

_compile

• _compile(withExtension: boolean): RegExp

  Parameters

  • withExtension: boolean

  Returns RegExp

_compileExtension

• _compileExtension(ext: PlaceholderType, withDefault: boolean): string

  Parameters

  • ext: PlaceholderType
  • withDefault: boolean

  Returns string

_compileType

• _compileType(type: PlaceholderType): string

  Parameters

  • type: PlaceholderType

  Returns string

_tokenize

• _tokenize(): void

  Returns void

match

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

  Match pattern against entire path.

  Parameters

  • path: string
  • options: MatchOptions

  Returns Record<string, any> | null

matchPartial

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

  Match pattern against path and return the remainder.

  Parameters

  • path: string
  • options: MatchOptions

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

parse

• parse(path?: string): this

  Parse pattern.

  Parameters

  • path: string = ''

  Returns this

render

• render(values: Record<string, string>, options: MatchOptions): string

  Render pattern into a path with parameters.

  Parameters

  • values: Record<string, string>
  • options: MatchOptions

  Returns string