@maxgraph/core/lib/esm/util/StringUtils.d.ts

maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.

import type { Properties } from '../types.js';
/**
 * Strips all whitespaces from the beginning of the string. Without the
 * second parameter, this will trim these characters:
 *
 * - " " (ASCII 32 (0x20)), an ordinary space
 * - "\t" (ASCII 9 (0x09)), a tab
 * - "\n" (ASCII 10 (0x0A)), a new line (line feed)
 * - "\r" (ASCII 13 (0x0D)), a carriage return
 * - "\0" (ASCII 0 (0x00)), the NUL-byte
 * - "\x0B" (ASCII 11 (0x0B)), a vertical tab
 */
export declare const ltrim: (str: string | null, chars?: string) => string | null;
/**
 * Strips all whitespaces from the end of the string. Without the second
 * parameter, this will trim these characters:
 *
 * - " " (ASCII 32 (0x20)), an ordinary space
 * - "\t" (ASCII 9 (0x09)), a tab
 * - "\n" (ASCII 10 (0x0A)), a new line (line feed)
 * - "\r" (ASCII 13 (0x0D)), a carriage return
 * - "\0" (ASCII 0 (0x00)), the NUL-byte
 * - "\x0B" (ASCII 11 (0x0B)), a vertical tab
 */
export declare const rtrim: (str: string | null, chars?: string) => string | null;
/**
 * Strips all whitespaces from both end of the string.
 * Without the second parameter, Javascript function will trim these
 * characters:
 *
 * - " " (ASCII 32 (0x20)), an ordinary space
 * - "\t" (ASCII 9 (0x09)), a tab
 * - "\n" (ASCII 10 (0x0A)), a new line (line feed)
 * - "\r" (ASCII 13 (0x0D)), a carriage return
 * - "\0" (ASCII 0 (0x00)), the NUL-byte
 * - "\x0B" (ASCII 11 (0x0B)), a vertical tab
 */
export declare const trim: (str: string | null, chars?: string) => string | null;
/**
 * Returns the name for the given function.
 *
 * @param f JavaScript object that represents a function.
 */
export declare const getFunctionName: (f: any) => string;
/**
 * Replaces each trailing newline with the given pattern.
 */
export declare const replaceTrailingNewlines: (str: string, pattern: string) => string;
/**
 * Removes the sibling text nodes for the given node that only consists
 * of tabs, newlines and spaces.
 *
 * @param node DOM node whose siblings should be removed.
 * @param before Optional boolean that specifies the direction of the traversal.
 */
export declare const removeWhitespace: (node: HTMLElement, before: boolean) => void;
/**
 * Replaces characters (less than, greater than, newlines and quotes) with
 * their HTML entities in the given string and returns the result.
 *
 * @param s String that contains the characters to be converted.
 * @param newline If newlines should be replaced. Default is `true`.
 */
export declare const htmlEntities: (s: string, newline?: boolean) => string;
/**
 * Returns a textual representation of the specified object.
 *
 * @param obj Object to return the string representation for.
 */
export declare const toString: (obj: Properties) => string;