Uri class

Paket:

azure-devops-extension-api

Kelas yang mewakili Uri dan memungkinkan penguraian/mendapatkan dan pengaturan bagian individual

Konstruktor

Uri(string, IUriParseOptions)

Buat Uri baru.

Properti

absoluteUri	Atur string uri absolut untuk Uri ini. Menggantikan semua nilai yang ada
hashString	String hash uri
host	Nama host uri (tidak termasuk port atau skema)
noSchemeSeparator	Jika true, jangan keluarkan pemisah "//" setelah skema: Atur ke true untuk skema seperti mailto (misalnya mailto:foo@bar)
path	Jalur relatif uri
port	Nomor port uri sebagaimana disediakan dalam url. 0 jika dibiarkan di url (misalnya port default untuk skema).
queryParameters	Array parameter kueri dalam uri
queryString	Atur string kueri untuk Uri ini. Menggantikan nilai yang ada
scheme	Skema uri seperti http atau https

Metode

addQueryParam(string, null | string, boolean)	Menambahkan parameter string kueri ke uri saat ini
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	Menambahkan parameter string kueri ke uri saat ini
getEffectivePort()	Mendapatkan nomor port yang efektif, mengembalikan nomor port default jika dihilangkan untuk skema yang diberikan.
getQueryParam(string)	Mendapatkan nilai parameter kueri dengan kunci yang diberikan
removeQueryParam(string)	Menghapus parameter string kueri

Detail Konstruktor

Uri(string, IUriParseOptions)

Buat Uri baru.

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

Parameter

uri

string

String uri opsional untuk mengisi nilai dengan

options

IUriParseOptions

Opsi untuk mengurai string uri

Detail Properti

absoluteUri

Atur string uri absolut untuk Uri ini. Menggantikan semua nilai yang ada

absoluteUri: string

Nilai Properti

string

hashString

String hash uri

hashString: string

Nilai Properti

string

host

Nama host uri (tidak termasuk port atau skema)

host: string

Nilai Properti

string

noSchemeSeparator

Jika true, jangan keluarkan pemisah "//" setelah skema: Atur ke true untuk skema seperti mailto (misalnya mailto:foo@bar)

noSchemeSeparator: boolean

Nilai Properti

boolean

path

Jalur relatif uri

path: string

Nilai Properti

string

port

Nomor port uri sebagaimana disediakan dalam url. 0 jika dibiarkan di url (misalnya port default untuk skema).

port: number

Nilai Properti

number

queryParameters

Array parameter kueri dalam uri

queryParameters: IQueryParameter[]

Nilai Properti

IQueryParameter[]

queryString

Atur string kueri untuk Uri ini. Menggantikan nilai yang ada

queryString: string

Nilai Properti

string

scheme

Skema uri seperti http atau https

scheme: string

Nilai Properti

string

Detail Metode

addQueryParam(string, null | string, boolean)

Menambahkan parameter string kueri ke uri saat ini

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

Parameter

name

string

Nama parameter Kueri

value

null | string

Nilai parameter Kueri

replaceExisting

boolean

Jika true, ganti semua parameter yang ada dengan nama yang sama

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

Menambahkan parameter string kueri ke uri saat ini

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

Parameter

parameters

{[key: string]: QueryParameterValueType}

Parameter kueri untuk ditambahkan

replaceExisting

boolean

Jika true, ganti semua parameter yang ada dengan nama yang sama

keyPrefix

string

Jika ditentukan, nilai yang akan didahului ke semua kunci parameter kueri

getEffectivePort()

Mendapatkan nomor port yang efektif, mengembalikan nomor port default jika dihilangkan untuk skema yang diberikan.

function getEffectivePort(): number

Mengembalikan

number

getQueryParam(string)

Mendapatkan nilai parameter kueri dengan kunci yang diberikan

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

Parameter

name

string

Nama parameter kueri

Mengembalikan

undefined | null | string

removeQueryParam(string)

Menghapus parameter string kueri

function removeQueryParam(name: string)

Parameter

name

string

Nama parameter Kueri