URLBuilder class

Package(패키지):

@azure/core-http

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

메서드

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

메서드 세부 정보

appendPath(string | undefined)

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

function appendPath(path: string | undefined)

매개 변수

path

string | undefined

getHost()

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

function getHost(): string | undefined

반품

string | undefined

getPath()

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

function getPath(): string | undefined

반품

string | undefined

getPort()

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

function getPort(): string | undefined

반품

string | undefined

getQuery()

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

function getQuery(): string | undefined

반품

string | undefined

getQueryParameterValue(string)

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

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

매개 변수

queryParameterName

string

반품

string | string[] | undefined

getScheme()

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

function getScheme(): string | undefined

반품

string | undefined

parse(string)

지정된 문자열 URL을 새 URLBuilder구문 분석합니다.

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(string | undefined)

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

function setHost(host: string | undefined)

매개 변수

host

string | undefined

setPath(string | undefined)

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

function setPath(path: string | undefined)

매개 변수

path

string | undefined

setPort(string | number | undefined)

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

function setPort(port: string | number | undefined)

매개 변수

port

string | number | undefined

setQuery(string | undefined)

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

function setQuery(query: string | undefined)

매개 변수

query

string | undefined

setQueryParameter(string, unknown)

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

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

매개 변수

queryParameterName

string

queryParameterValue

unknown

setScheme(string | undefined)

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

function setScheme(scheme: string | undefined)

매개 변수

scheme

string | undefined

toString()

URL을 문자열로 직렬화합니다.

function toString(): string

반품

string

URL을 문자열로 지정합니다.