@pnp/spfx-controls-react/lib/common/utilities/GeneralHelper.d.ts

Reusable React controls for SharePoint Framework solutions

import '../extensions/String.extensions';
export declare const IMG_SUPPORTED_EXTENSIONS = ".gif,.jpg,.jpeg,.bmp,.dib,.tif,.tiff,.ico,.png,.jxr,.svg";
/**
 * Helper with general methods to simplify some routines
 */
export declare class GeneralHelper {
    /**
     * Trims slash at the end of URL if needed
     * @param url URL
     */
    static trimSlash(url: string): string;
    /**
     * Encodes text
     * @param text text to encode
     */
    static encodeText(text: string): string;
    /**
     * Copy of Microsoft's GetRelativeDateTimeString from SP.dateTimeUtil
     */
    static getRelativeDateTimeString(format: string): string;
    /**
     * Copy of Microsoft's GetLocalizedCountValue from SP.dateTimeUtil.
     * I've tried to rename all the vars to have meaningful names... but some were too unclear
     */
    static getLocalizedCountValue(format: string, first: string, second: number): string;
    /**
     * Extracts text from HTML strings without creating HTML elements
     * @param html HTML string
     */
    static getTextFromHTML(html: string): string;
    /**
     * Checks if value is defined (not null and not undefined)
     * @param value value
     */
    static isDefined(value: any): boolean;
    /**
     * Creates Document element based on Xml string
     * @param xmlString XML string to parse
     */
    static parseXml(xmlString: string): Document;
    /**
     * Returns absoulute domain URL.
     * @param url
     */
    static getAbsoluteDomainUrl(url: string): string;
    static getDomain(url: string, includeProtocol?: boolean): string;
    /**
     * To support IE11 that has no support for File constructor
     * @param blob
     */
    static getFileFromBlob(blob: Blob, fileName: string): File;
    static formatBytes(bytes: any, decimals: any): string;
    /**
     * Returns file name without extension.
     */
    static getFileNameWithoutExtension(itemUrl: string): string;
    /**
     * Returns file name with the extension
     */
    static getFileNameFromUrl(itemUrl: string): string;
    static isImage(fileName: string): boolean;
    /**
     * Returns extension of the file
     */
    static getFileExtension(fileName: any): string;
    private static _getEncodedChar;
}
export declare function urlCombine(urlStart: string, urlFinish: string, escapeFinish?: boolean): string;
export declare const toRelativeUrl: (absoluteUrl: string) => string;
export declare function sortString(a: string, b: string, isDesc: boolean): number;
export declare function sortDate(a: string | number | Date, b: string | number | Date, isDesc: boolean): number;
export declare function dateToNumber(date: string | number | Date): number;
//# sourceMappingURL=GeneralHelper.d.ts.map