URLBuilder class

패키지:

@azure/ms-rest-js

URL 만들기, 수정 및 구문 분석을 처리하는 클래스입니다.

메서드

appendPath(undefined | string)	제공된 경로를 이 URL의 기존 경로에 추가합니다. 제공된 경로에 쿼리가 포함된 경우 이 URL에도 추가됩니다.
getHost()	이 URL에 설정된 호스트를 가져옵니다.
getPath()	이 URL에 설정된 경로를 가져옵니다.
getPort()	이 URL에 설정된 포트를 가져옵니다.
getQuery()	이 URL에서 쿼리를 가져옵니다.
getQueryParameterValue(string)	제공된 쿼리 매개 변수 이름을 사용하여 쿼리 매개 변수의 값을 가져옵니다. 제공된 이름을 가진 쿼리 매개 변수가 없으면 undefined가 반환됩니다.
getScheme()	이 URL에 설정된 체계를 가져옵니다.
parse(string)
replaceAll(string, string)	제공된 searchValue가 이 URLBuilder에 있는 경우 제공된 replaceValue로 바꿉니다.
setHost(undefined | string)	이 URL에 대한 호스트를 설정합니다. 제공된 호스트에 URL의 다른 부분(예: 포트, 경로 또는 쿼리)이 포함된 경우 해당 부분도 이 URL에 추가됩니다.
setPath(undefined | string)	이 URL의 경로를 설정합니다. 제공된 경로에 쿼리가 포함된 경우 이 URL에도 추가됩니다.
setPort(undefined | string | number)	이 URL의 포트를 설정합니다. 제공된 포트에 URL의 다른 부분(예: 경로 또는 쿼리)이 포함된 경우 해당 부분도 이 URL에 추가됩니다.
setQuery(undefined | string)	이 URL에서 쿼리를 설정합니다.
setQueryParameter(string, any)	이 URL의 쿼리에서 제공된 이름과 값을 사용하여 쿼리 매개 변수를 설정합니다. 제공된 쿼리 매개 변수 값이 정의되지 않거나 비어 있으면 쿼리 매개 변수가 있는 경우 제거됩니다.
setScheme(undefined | string)	이 URL에 대한 체계/프로토콜을 설정합니다. 제공된 스키마에 URL의 다른 부분(예: 호스트, 포트, 경로 또는 쿼리)이 포함된 경우 해당 부분도 이 URL에 추가됩니다.
toString()

메서드 세부 정보

appendPath(undefined | string)

제공된 경로를 이 URL의 기존 경로에 추가합니다. 제공된 경로에 쿼리가 포함된 경우 이 URL에도 추가됩니다.

function appendPath(path: undefined | string)

매개 변수

path

undefined | string

getHost()

이 URL에 설정된 호스트를 가져옵니다.

function getHost(): undefined | string

반환

undefined | string

getPath()

이 URL에 설정된 경로를 가져옵니다.

function getPath(): undefined | string

반환

undefined | string

getPort()

이 URL에 설정된 포트를 가져옵니다.

function getPort(): undefined | string

반환

undefined | string

getQuery()

이 URL에서 쿼리를 가져옵니다.

function getQuery(): undefined | string

반환

undefined | string

getQueryParameterValue(string)

제공된 쿼리 매개 변수 이름을 사용하여 쿼리 매개 변수의 값을 가져옵니다. 제공된 이름을 가진 쿼리 매개 변수가 없으면 undefined가 반환됩니다.

function getQueryParameterValue(queryParameterName: string): undefined | string | string[]

매개 변수

queryParameterName

string

반환

undefined | string | string[]

getScheme()

이 URL에 설정된 체계를 가져옵니다.

function getScheme(): undefined | string

반환

undefined | string

parse(string)

static function parse(text: string): URLBuilder

매개 변수

text

string

반환

URLBuilder

replaceAll(string, string)

제공된 searchValue가 이 URLBuilder에 있는 경우 제공된 replaceValue로 바꿉니다.

function replaceAll(searchValue: string, replaceValue: string)

매개 변수

searchValue

string

replaceValue

string

setHost(undefined | string)

이 URL에 대한 호스트를 설정합니다. 제공된 호스트에 URL의 다른 부분(예: 포트, 경로 또는 쿼리)이 포함된 경우 해당 부분도 이 URL에 추가됩니다.

function setHost(host: undefined | string)

매개 변수

host

undefined | string

setPath(undefined | string)

이 URL의 경로를 설정합니다. 제공된 경로에 쿼리가 포함된 경우 이 URL에도 추가됩니다.

function setPath(path: undefined | string)

매개 변수

path

undefined | string

setPort(undefined | string | number)

이 URL의 포트를 설정합니다. 제공된 포트에 URL의 다른 부분(예: 경로 또는 쿼리)이 포함된 경우 해당 부분도 이 URL에 추가됩니다.

function setPort(port: undefined | string | number)

매개 변수

port

undefined | string | number

setQuery(undefined | string)

이 URL에서 쿼리를 설정합니다.

function setQuery(query: undefined | string)

매개 변수

query

undefined | string

setQueryParameter(string, any)

이 URL의 쿼리에서 제공된 이름과 값을 사용하여 쿼리 매개 변수를 설정합니다. 제공된 쿼리 매개 변수 값이 정의되지 않거나 비어 있으면 쿼리 매개 변수가 있는 경우 제거됩니다.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

매개 변수

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

이 URL에 대한 체계/프로토콜을 설정합니다. 제공된 스키마에 URL의 다른 부분(예: 호스트, 포트, 경로 또는 쿼리)이 포함된 경우 해당 부분도 이 URL에 추가됩니다.

function setScheme(scheme: undefined | string)

매개 변수

scheme

undefined | string

toString()

function toString(): string

반환

string