starling-framework/lib/starling/utils/StringUtil.d.ts

A fast, productive library for 2D cross-platform development.

declare namespace starling.utils {
	/**
	 *  A utility class with methods related to the String class. 
	 */
	export class StringUtil {
		/**
		 *  Formats a String in .Net-style, with curly braces ("{0}"). Does not support any
		 *      *  number formatting options yet. 
		 */
		static format(format: string, args: Array<any>): string;
		/**
		 *  Replaces a string's "master string" — the string it was built from —
		 *      *  with a single character to save memory. Find more information about this AS3 oddity
		 *      *  <a href="http://jacksondunstan.com/articles/2260">here</a>.
		 *      *
		 *      *  @param  string The String to clean
		 *      *  @return The input string, but with a master string only one character larger than it.
		 *      *  @author Jackson Dunstan, JacksonDunstan.com
		 *      
		 */
		static clean(string: string): string;
		/**
		 *  Removes all leading white-space and control characters from the given String.
		 *      *
		 *      *  <p>Beware: this method does not make a proper Unicode white-space check,
		 *      *  but simply trims all character codes of '0x20' or below.</p>
		 *      
		 */
		static trimStart(string: string): string;
		/**
		 *  Removes all trailing white-space and control characters from the given String.
		 *      *
		 *      *  <p>Beware: this method does not make a proper Unicode white-space check,
		 *      *  but simply trims all character codes of '0x20' or below.</p>
		 *      
		 */
		static trimEnd(string: string): string;
		/**
		 *  Removes all leading and trailing white-space and control characters from the given
		 *      *  String.
		 *      *
		 *      *  <p>Beware: this method does not make a proper Unicode white-space check,
		 *      *  but simply trims all character codes of '0x20' or below.</p>
		 *      
		 */
		static trim(string: string): string;
		/**
		 *  Returns <code>true</code> if <code>value</code> equals
		 *      *  <code>true, TRUE, True, or 1</code>.
		 *      
		 */
		static parseBoolean(value: string): boolean;
	}
}
export default starling.utils.StringUtil;