matchPath

• Framework
• Data
• Declarative

概要

リファレンスドキュメント ↗

URL パス名に対してパターンマッチングを実行し、マッチに関する情報を返します。

シグネチャ

function matchPath<ParamKey extends ParamParseKey<Path>, Path extends string>(
  pattern: PathPattern<Path> | Path,
  pathname: string,
): PathMatch<ParamKey> | null

パラメータ

pattern

URL パス名と照合するパターンです。これは文字列または PathPattern オブジェクトのいずれかです。文字列が提供された場合、caseSensitive が false、end が true に設定されたパターンとして扱われます。

pathname

パターンと照合する URL パス名です。

戻り値

パターンがパス名にマッチした場合、パスのマッチオブジェクトを返します。マッチしない場合は null を返します。