Framework
Version

MatchRouteOptions type

The MatchRouteOptions type is used to describe the options that can be used when matching a route.

tsx
interface MatchRouteOptions {
  pending?: boolean
  caseSensitive?: boolean
  includeSearch?: boolean
  fuzzy?: boolean
}
interface MatchRouteOptions {
  pending?: boolean
  caseSensitive?: boolean
  includeSearch?: boolean
  fuzzy?: boolean
}

MatchRouteOptions properties

The MatchRouteOptions type has the following properties:

pending property

  • Type: boolean
  • Optional
  • If true, will match against pending location instead of the current location

caseSensitive property

  • Type: boolean
  • Optional
  • If true, will match against the current location with case sensitivity

includeSearch property

  • Type: boolean
  • Optional
  • If true, will match against the current location's search params using a deep inclusive check. e.g. { a: 1 } will match for a current location of { a: 1, b: 2 }

fuzzy property

  • Type: boolean
  • Optional
  • If true, will match against the current location using a fuzzy match. e.g. /posts will match for a current location of /posts/123
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.