Uri class

패키지:

azure-devops-extension-api

URI를 나타내고 개별 파트의 구문 분석/가져오기 및 설정을 허용하는 클래스

생성자

Uri(string, IUriParseOptions)

새 URI를 만듭니다.

속성

absoluteUri	이 URI에 대한 절대 URI 문자열을 설정합니다. 모든 기존 값을 대체합니다.
hashString	URI의 해시 문자열입니다.
host	uri 호스트 이름(포트 또는 구성표는 포함되지 않음)
noSchemeSeparator	true이면 체계 다음에 "//" 구분 기호를 내보내지 마세요. mailto(예: mailto:foo@bar)와 같은 스키마에 대해 true로 설정합니다.
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(예: mailto:foo@bar)와 같은 스키마에 대해 true로 설정합니다.

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

쿼리 매개 변수 이름