58 lines
2.1 KiB
TypeScript
58 lines
2.1 KiB
TypeScript
|
import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse";
|
||
|
|
import { IUri } from "./IUri";
|
||
|
|
/**
|
||
|
|
* Url object class which can perform various transformations on url strings.
|
||
|
|
*/
|
||
|
|
export declare class UrlString {
|
||
|
|
private _urlString;
|
||
|
|
get urlString(): string;
|
||
|
|
constructor(url: string);
|
||
|
|
/**
|
||
|
|
* Ensure urls are lower case and end with a / character.
|
||
|
|
* @param url
|
||
|
|
*/
|
||
|
|
static canonicalizeUri(url: string): string;
|
||
|
|
/**
|
||
|
|
* Throws if urlString passed is not a valid authority URI string.
|
||
|
|
*/
|
||
|
|
validateAsUri(): void;
|
||
|
|
/**
|
||
|
|
* Function to remove query string params from url. Returns the new url.
|
||
|
|
* @param url
|
||
|
|
* @param name
|
||
|
|
*/
|
||
|
|
urlRemoveQueryStringParameter(name: string): string;
|
||
|
|
static removeHashFromUrl(url: string): string;
|
||
|
|
/**
|
||
|
|
* Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns https://a:b/tenantId/d
|
||
|
|
* @param href The url
|
||
|
|
* @param tenantId The tenant id to replace
|
||
|
|
*/
|
||
|
|
replaceTenantPath(tenantId: string): UrlString;
|
||
|
|
/**
|
||
|
|
* Returns the anchor part(#) of the URL
|
||
|
|
*/
|
||
|
|
getHash(): string;
|
||
|
|
/**
|
||
|
|
* Parses out the components from a url string.
|
||
|
|
* @returns An object with the various components. Please cache this value insted of calling this multiple times on the same url.
|
||
|
|
*/
|
||
|
|
getUrlComponents(): IUri;
|
||
|
|
static getDomainFromUrl(url: string): string;
|
||
|
|
static getAbsoluteUrl(relativeUrl: string, baseUrl: string): string;
|
||
|
|
/**
|
||
|
|
* Parses hash string from given string. Returns empty string if no hash symbol is found.
|
||
|
|
* @param hashString
|
||
|
|
*/
|
||
|
|
static parseHash(hashString: string): string;
|
||
|
|
static constructAuthorityUriFromObject(urlObject: IUri): UrlString;
|
||
|
|
/**
|
||
|
|
* Returns URL hash as server auth code response object.
|
||
|
|
*/
|
||
|
|
static getDeserializedHash(hash: string): ServerAuthorizationCodeResponse;
|
||
|
|
/**
|
||
|
|
* Check if the hash of the URL string contains known properties
|
||
|
|
*/
|
||
|
|
static hashContainsKnownProperties(hash: string): boolean;
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=UrlString.d.ts.map
|