Uri class

パッケージ:

azure-devops-extension-api

Uri を表し、個々の部分の解析/取得と設定を可能にするクラス

コンストラクター

Uri(string, IUriParseOptions)

新しい URI を作成します。

プロパティ

absoluteUri	この URI の絶対 URI 文字列を設定します。 既存のすべての値を置き換えます
hashString	URI のハッシュ文字列
host	URI ホスト名 (ポートまたはスキームは含まれません)
noSchemeSeparator	true の場合は、スキームの後に "//" 区切り記号を出力しないでください。mailto などのスキームに対して true に設定します (例: mailto:foo@bar)
path	URI の相対パス
port	URL に指定されている URI のポート番号。 URL に省略されている場合は 0 (スキームの既定のポートなど)。
queryParameters	URI 内のクエリ パラメーターの配列
queryString	この URI のクエリ文字列を設定します。 既存の値を置き換えます
scheme	http や https などの URI スキーム

メソッド

addQueryParam(string, null | string, boolean)	クエリ文字列パラメーターを現在の URI に追加します
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	クエリ文字列パラメーターを現在の URI に追加します
getEffectivePort()	有効なポート番号を取得し、指定されたスキームで省略した場合は既定のポート番号を返します。
getQueryParam(string)	指定されたキーを使用してクエリ パラメーターの値を取得します
removeQueryParam(string)	クエリ文字列パラメーターを削除します。

コンストラクターの詳細

Uri(string, IUriParseOptions)

新しい URI を作成します。

new Uri(uri?: string, options?: IUriParseOptions)

パラメーター

uri

string

値を設定する省略可能な URI 文字列

options

IUriParseOptions

URI 文字列を解析するためのオプション

プロパティの詳細

absoluteUri

この URI の絶対 URI 文字列を設定します。 既存のすべての値を置き換えます

absoluteUri: string

プロパティ値

string

hashString

URI のハッシュ文字列

hashString: string

プロパティ値

string

host

URI ホスト名 (ポートまたはスキームは含まれません)

host: string

プロパティ値

string

noSchemeSeparator

true の場合は、スキームの後に "//" 区切り記号を出力しないでください。mailto などのスキームに対して true に設定します (例: mailto:foo@bar)

noSchemeSeparator: boolean

プロパティ値

boolean

path

URI の相対パス

path: string

プロパティ値

string

port

URL に指定されている URI のポート番号。 URL に省略されている場合は 0 (スキームの既定のポートなど)。

port: number

プロパティ値

number

queryParameters

URI 内のクエリ パラメーターの配列

queryParameters: IQueryParameter[]

プロパティ値

IQueryParameter[]

queryString

この URI のクエリ文字列を設定します。 既存の値を置き換えます

queryString: string

プロパティ値

string

scheme

http や https などの URI スキーム

scheme: string

プロパティ値

string

メソッドの詳細

addQueryParam(string, null | string, boolean)

クエリ文字列パラメーターを現在の URI に追加します

function addQueryParam(name: string, value: null | string, replaceExisting?: boolean)

パラメーター

name

string

クエリ パラメーター名

value

null | string

クエリ パラメーターの値

replaceExisting

boolean

true の場合、既存のすべてのパラメーターを同じ名前に置き換えます

addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)

クエリ文字列パラメーターを現在の URI に追加します

function addQueryParams(parameters: {[key: string]: QueryParameterValueType}, replaceExisting?: boolean, keyPrefix?: string)

パラメーター

parameters

{[key: string]: QueryParameterValueType}

追加するクエリ パラメーター

replaceExisting

boolean

true の場合、既存のすべてのパラメーターを同じ名前に置き換えます

keyPrefix

string

指定した場合、すべてのクエリ パラメーター キーの前に追加する値

getEffectivePort()

有効なポート番号を取得し、指定されたスキームで省略した場合は既定のポート番号を返します。

function getEffectivePort(): number

戻り値

number

getQueryParam(string)

指定されたキーを使用してクエリ パラメーターの値を取得します

function getQueryParam(name: string): undefined | null | string

パラメーター

name

string

クエリ パラメーター名

戻り値

undefined | null | string

removeQueryParam(string)

クエリ文字列パラメーターを削除します。

function removeQueryParam(name: string)

パラメーター

name

string

クエリ パラメーター名