remix/route-pattern · Interface

View Source

RoutePatternCapture

Summary

A variable (:name) or wildcard (*name) declared in a RoutePattern.

Signature

interface RoutePatternCapture {
  name: string
  optional: boolean
  part: 'hostname' | 'pathname'
  type: ':' | '*'
}

Properties

name

Capture name, or * for an unnamed wildcard.

optional

Whether the capture is inside an optional group.

part

The URL part that contains the capture.

type

The capture token kind: : for variables or * for wildcards.