@mikezimm/fps-core-v7
Version:
Library of reusable core interfaces, types and constants migrated from fps-library-v2
51 lines (50 loc) • 2.03 kB
TypeScript
/**
* 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 declare function getUrlVarsAsObject(): any;
/**
* getUrlVarsAsStrings was originally: getUrlVars
* turns url variables array of strings like `param=value`;
* This was originally from Pivot Tiles
* @returns
*/
export declare function getUrlVarsAsStrings(): 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