@mikezimm/fps-core-v7/lib/logic/Links/UrlFunctions.d.ts

Library of reusable core interfaces, types and constants migrated from fps-library-v2

/**
 * CodeAnalizerComment: Updated 1 imports on 2024-09-21 23:07:24
 * Update:: import { ISimpleLink } to '@mikezimm/fps-core-v7/lib/logic/Links/interfaces/ISimpleLink;'

 */
import { ISimpleLink } from "./interfaces/ISimpleLink";
export declare function getBrowser(validTypes: any, changeSiteIcon: any): string;
export declare function amIOnThisWeb(webUrl: string): boolean;
/**
 * Takes in full url like from a list or library and tries to trim it down to a web url.
 * Only is able to fix some links to common lists, libraries and system pages
 * @param SiteLink
 * @param absoluteOrRelative
 * @returns
 */
export declare function getWebUrlFromLink(SiteLink: string | null, absoluteOrRelative: 'abs' | 'rel'): string;
/**
 * getUrlVarsAsObject was copied from Pivot Tiles.... and was called getUrlVars THEIR
 * turns url variables into an object where the keys equal the paramters and the value is the value of the paramter
 * This was originally from Pivot Tiles
 * @returns
 */
export interface IUrlVarOptions {
    remove?: string[];
}
/**
 * https://github.com/fps-solutions/SayWhat/issues/153
 * Added optional url params to getUrlVars functions to remove the teams bloat and clean up analytics.
 */
export declare const TeamsBloatUrlParamsToStrip: string[];
export declare function getUrlVarsAsObject(options?: IUrlVarOptions): any;
/**
 * getUrlVarsAsStrings was originally: getUrlVars
 * turns url variables array of strings like `param=value`;
 * This was originally from Pivot Tiles
 * https://github.com/fps-solutions/SayWhat/issues/153
 *
 * @param options - Added to remove Teams Bloat in params... pass in TeamsBloatUrlParamsToStrip to clean those up
 * @returns
 */
export declare function getUrlVarsAsStrings(options?: IUrlVarOptions): string[];
/**
 * https://github.com/fps-solutions/SayWhat/issues/153
 * ElphabApproved = OneNight ( squashBug(longURL) && defiedGravity('11/20/25') )
 * Returns URL parameters as a string, trimmed to a maximum length.
 * If the joined params exceed maxLength, trims and appends
 * "& TEAMS_BLOAT_SERVICE=true" to indicate bloat was removed.
 *
 * @param remove Optional array of URL parameter keys to strip out (defaults to Teams bloat params)
 * @param maxLength Maximum total length of final string (default 250)
 */
export declare function getUrlParamsWithBloatCheck(remove?: string[], maxLength?: number): string;
/**
 * Returns standard link object with Url and Description
 *  2025-02-25:  NOTE:  This does NOT TRIM the PageURL... and SharePoint Url Columns MUST be trimmed to 255 chars.
 * @returns
 */
export declare function getCurrentPageLink(): ISimpleLink;
/**
 * Returns standard link object with Url and Description
 * @param TargetList
 * @param webTitle
 * @returns
 */
export declare function makeListLink(TargetList: string, webTitle: string): ISimpleLink | null;
/**
 * Returns standard link object with Url and Description
 * @param TargetSite
 * @param webTitle
 * @returns
 */
export declare function makeSiteLink(TargetSite: string, webTitle: string): ISimpleLink | null;
//# sourceMappingURL=UrlFunctions.d.ts.map