Class UrlString

Url object class which can perform various transformations on url strings.

Hierarchy

UrlString

Index

Constructors

Accessors

Methods

getHash getUrlComponents replaceTenantPath validateAsUri appendQueryString canonicalizeUri constructAuthorityUriFromObject getAbsoluteUrl getDeserializedCodeResponse getDeserializedHash getDeserializedQueryString getDomainFromUrl hashContainsKnownProperties parseHash parseQueryServerResponse parseQueryString removeHashFromUrl

Constructors

constructor

new UrlString(url): UrlString
Parameters
- url: string
Returns UrlString
- Defined in msal-common/dist/url/UrlString.d.ts:10

Accessors

urlString

get urlString(): string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:9

Methods

getHash

getHash(): string
Returns the anchor part(#) of the URL

Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:40

getUrlComponents

getUrlComponents(): IUri
Parses out the components from a url string.

Returns IUri
An object with the various components. Please cache this value insted of calling this multiple times on the same url.
- Defined in msal-common/dist/url/UrlString.d.ts:45

replaceTenantPath

replaceTenantPath(tenantId): UrlString
Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns https://a:b/tenantId/d
Parameters
- tenantId: string
  
  The tenant id to replace
Returns UrlString
- Defined in msal-common/dist/url/UrlString.d.ts:36

validateAsUri

validateAsUri(): void
Throws if urlString passed is not a valid authority URI string.

Returns void
- Defined in msal-common/dist/url/UrlString.d.ts:19

`Static` appendQueryString

appendQueryString(url, queryString): string
Given a url and a query string return the url with provided query string appended
Parameters
- url: string
- queryString: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:25

`Static` canonicalizeUri

canonicalizeUri(url): string
Ensure urls are lower case and end with a / character.
Parameters
- url: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:15

`Static` constructAuthorityUriFromObject

constructAuthorityUriFromObject(urlObject): UrlString
Parameters
- urlObject: IUri
Returns UrlString
- Defined in msal-common/dist/url/UrlString.d.ts:65

`Static` getAbsoluteUrl

getAbsoluteUrl(relativeUrl, baseUrl): string
Parameters
- relativeUrl: string
- baseUrl: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:47

`Static` getDeserializedCodeResponse

getDeserializedCodeResponse(serverResponseType, hashFragment): ServerAuthorizationCodeResponse
Returns either deserialized query string or deserialized hash, depending on the serverResponseType as a server auth code response object.
Parameters
- serverResponseType: undefined | ServerResponseType
- hashFragment: string
Returns ServerAuthorizationCodeResponse
- Defined in msal-common/dist/url/UrlString.d.ts:78

`Static` getDeserializedHash

getDeserializedHash(hash): ServerAuthorizationCodeResponse
Returns URL hash as server auth code response object.
Parameters
- hash: string
Returns ServerAuthorizationCodeResponse
- Defined in msal-common/dist/url/UrlString.d.ts:69

`Static` getDeserializedQueryString

getDeserializedQueryString(query): ServerAuthorizationCodeResponse
Returns URL query string as server auth code response object.
Parameters
- query: string
Returns ServerAuthorizationCodeResponse
- Defined in msal-common/dist/url/UrlString.d.ts:73

`Static` getDomainFromUrl

getDomainFromUrl(url): string
Parameters
- url: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:46

`Static` hashContainsKnownProperties

hashContainsKnownProperties(hash): boolean
Check if the hash of the URL string contains known properties
Parameters
- hash: string
Returns boolean
- Defined in msal-common/dist/url/UrlString.d.ts:82

`Static` parseHash

parseHash(hashString): string
Parses hash string from given string. Returns empty string if no hash symbol is found.
Parameters
- hashString: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:52

`Static` parseQueryServerResponse

parseQueryServerResponse(queryString): string
Parses query server response string from given string. Extract hash between '?code=' and '#' if trailing '# is present. Returns empty string if no query symbol is found.
Parameters
- queryString: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:64

`Static` parseQueryString

parseQueryString(queryString): string
Parses query string from given string. Returns empty string if no query symbol is found.
Parameters
- queryString: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:57

`Static` removeHashFromUrl

removeHashFromUrl(url): string
Returns a url with the hash removed
Parameters
- url: string
Returns string
- Defined in msal-common/dist/url/UrlString.d.ts:30

Generated using TypeDoc