Table of Contents

URLUtil

概要

URLに関する処理を行う、ユーティリティークラスです。

メソッド

buildQuery(options)

型:String Static

引数で与えられたオブジェクトから、URLのクエリー部を生成します。各キーと値はURLEncodeされます。値が配列の場合、それぞれの要素はカンマで連結されます。

パラメータ

パラメータ型説明
options
必須		ObjectURLのクエリーパラメータのオブジェクトです。

戻り値

URLのクエリー文字列を返します。クエリー文字列が空文字列ではない場合、先頭に?を付加します。

buildURL(routeInfo, options)

型:String Static

指定されたルート情報オブジェクトを元に、URLを生成します。

まず、ルート情報に“href”が含まれる場合それを使用し、含まれない場合はルート情報の“pathname”と現在のベースURL（document.baseURI）を元にURLが生成されます。 “pathname”は絶対パス、相対パスいずれか指定可能です。 “href”も“pathname”も存在しない場合、現在のURLを元に生成されます。

さらにその後、 “protocol”・“username”・“password”・“host”・“hostname”・“port”・“search”・“hash＂がルート情報に含まれる場合、その値が追加/上書きされます。

最後にルート情報に”queryParameters“が含まれる場合、そのオブジェクトを元にクエリー部が生成され、URLに付加されます。”mergeParameters“オプションがTrueの場合、現在のURLクエリーにパラメータが上書きマージされます。

パラメータ

パラメータ型説明
routeInfo
必須		ObjectURLを組み立てるためのルート情報です。以下のキーがあります。
“href”StringURL全体です。
“protocol”StringURLのプロトコル部です。
“username”StringURLのユーザー名部です。
“password”StringURLのパスワード部です。
“host”StringURLのホスト部です。ポートを含むことができます。
“hostname”StringURLのホスト部です。ポートは含みません。
“port”StringURLのポート部です。
“pathname”StringURLのパス部です。
“search”StringURLのクエリー部です。
“hash”StringURLのハッシュ部です。
“queryParameters”Objectクエリーのパラメータ部のオブジェクトです。
optionsObjectオプションを指定します。以下のキーがあります。
“mergeParameters”StringTrueの場合、現在のURLのクエリーにルート情報のクエリーパラメータをマージします。

戻り値

生成したURLを返します。

loadParameters(url)

型:Object Static

指定されたURLのクエリー部分を、オブジェクトに変換して返します。

パラメータ

パラメータ型説明
urlString対象となるURLを指定します。指定がない場合、現在のURLが使用されます。

戻り値

クエリー部のオブジェクトを返します。

parseURL(url)

型:Object Static

引数で与えられたURLを分解し、格納したオブジェクトを返します。オブジェクトは以下の情報を持ちます。

キー型説明
“href”StringURL全体です。
“protocol”StringURLのプロトコル部です。
“username”StringURLのユーザー名部です。
“password”StringURLのパスワード部です。
“host”StringURLのホスト部です。ポートが指定されている場合は、ポートも含みます。
“hostname”StringURLのホスト部です。ポートは含みません。
“port”StringURLのポート部です。
“pathname”StringURLのパス部です。
“path”StringURLのパス部からファイル名部を取り除いたものです。
“search”StringURLのクエリー部です。
“searchParams”URLSearchParamsURLのクエリー部です。
“hash”StringURLのハッシュ部です。
“filename”StringURLのファイル名部です。
“filenameWithoutExtension”StringURLの拡張子なしのファイル名部です。
“extension”StringURLのファイル名の拡張子部です。
“queryParameters”ObjectURLのクエリー部をオブジェクトに変換したものです。

パラメータ

パラメータ型説明
urlString対象となるURLです。指定がない場合は、現在のURLが対象となります。

戻り値

URL情報のオブジェクトです。