js-extensions/js-extensions.d.ts

Object and String extensions

interface Object {
  /**
   * @description Returns an array of values of a given object's own enumerable properties, in 
   * the same order as that provided by a for...in loop.
   * @memberof Object
   * @method values
   * @param obj {*} The object whose enumerable own properties are to be returned.
   * @returns {Object} The array of property values.
   **/
  values(obj: any): Array<any>;

  /**
   * @description Makes a deep copy of an object
   * @memberof Object
   * @method clone
   * @param obj {*} The object to clone.
   * @returns {Object} The cloned object.
   */
  clone(obj: any): any;

  /**
   * @description Makes a deep copy of an object
   * @memberof Object
   * @method equals
   * @param obj {*} The first object to compare.
   * @param other The second object to compare.
   * @returns {boolean} True if both objects are equal. False, otherwise.
   */
  equals(obj: any, other: any): boolean;

  /**
   * @description Generates a hash code for an Object.
   * @memberof Object
   * @method hashCode
   * @param obj {*} The object to generate a hashcode from.
   * @returns {int} The hashcode of the Object.
   */
  hashCode(obj: any): number;

  /**
   * @description Determines if an Object is null or undefined.
   * @memberof Object
   * @method isNullOrUndefined
   * @param obj {*} The Object to test.
   * @returns {boolean} True if the Object is null or undefined. False otherwise.
   */
  isNullOrUndefined(obj: any): boolean;

  /**
   * @description Creates an object that includes members from the source objects
   * @memberof Object
   * @method merge
   * @param params {...*} The object to copy merge.
   * @returns {*} A new object that combines the source objects.
   */
  merge(...params: any[]): any;
}

interface ObjectConstructor {
  assign(target: any, ...sources: any[]): any;
  observe(target: any, callback: Function, acceptList?: Array<any>): void;
}

declare var Object: ObjectConstructor;

interface String {
  /**
   * @description Returns a new string containing a copy of the current string.
   * @method clone
   * @memberof String.prototype
   * @returns {String} A copy of the current string.
   * @example var newString = 'Hello World'.clone();
   */
  clone();

  /**
   * @description Determines if the string instance ends with another string.
   * @method endsWith
   * @memberof String
   * @param suffix {String} The string to check for.
   * @returns {boolean} True if string instance ends with the suffix string. False otherwise.
   * @example var endsWith = String.endsWith('string', 'ng');
   */
  endsWith(suffix: string): boolean;

  /**
   * @description Compares the current string to another string.
   * @method equals
   * @memberof String.prototype
   * @param other {String} The string to compare.
   * @returns {boolean} True if the current and other strings are equal. False otherwise.
   * @example var isEqual = 'string'.equals('string');
   */
  equals(other: string): boolean;

  /**
   * @description Formats a string using the current string as the format string.
   * Numbered tokens are used to insert values e.g. 'Format string {0}, {1}, {2}'.
   * @method format The format string is composed of zero or more directives:
   * ordinary characters (excluding %) that are copied directly to the result, and
   * conversion specifications, each of which results in fetching its own parameter.
   * @memberof String.prototype
   * @param params {...*} One or more parameters to format into the format string.
   * @returns {String} The formatted string.
   * @see String.format
   * @example 'Hello, my name is {0} {1}.'.sprintf('John', 'Doe');
   */
  format(...params: any[]): string;

  /**
   * @description Generates a hashcode for the current string.
   * @method hashCode
   * @memberof String.prototype
   * @returns {String} The hashcode for the current string.
   * @example 'Hello World'.hashCode();
   */
  hashCode(): number;

  /**
   * @description Determine if a string is null, undefined, or zero length.
   * @method isNullOrEmpty
   * @memberof String.prototype
   * @returns {boolean} True if null, undefined, or zero length. False otherwise.
   */
  isNullOrEmpty(): boolean;

  /**
   * @description Creates a copy of the current string with the leading whitespace
   * removed.
   * @method ltrim
   * @memberof String.prototype
   * @returns {String} The current string with the leading spaces removed.
   * @example '   Hello World'.ltrim();
   */
  ltrim(): string;

  /**
   * @description Generates a MD5 message digest for the current string instance.
   * @method md5
   * @memberof String.prototype
   * @returns {String} The MD5 message digest for the current string instance.
   * @example 'password'.md5();
   */
  md5():string;

  /**
   * @description Prints a formatted string using the current string as the format string.
   * @method print
   * @memberof String.prototype
   * @param params {...*} One or more parameters to format into the format string.
   * @example 'Hello, my name is {0} {1}.'.print('John', 'Doe');
   * @see String.format
   */
  print(...params: any[]): void;

  /**
   * @description Prints a formatted string using the current string as the format string.
   * @method printf
   * @memberof String.prototype
   * @param params {...*} One or more parameters to format into the format string.
   * @example 'Hello, my name is %s %s, I am %d years old.'.printf('John', 'Doe', 46);
   * @see String.sprintf
   */
  printf(...params: any[]): void;

  /**
   * @description Creates a copy of the current string with the trailing whitespace
   * removed.
   * @method rtrim
   * @memberof String.prototype
   * @returns {String} The current string with the trailing spaces removed.
   * @example 'Hello World   '.rtrim();
   */
  rtrim(): string;

  /**
   * @description Formats a string using the current string as the format string.
   * The format string uses tokens e.g. 'Format string %s, %d, %f'
   * @method sprintf
   * @memberof String.prototype
   * @param params {...*} One or more parameters to format into the format string.
   * @returns {String} The formatted string.
   * @see String.format
   * @example 'Hello, my name is %s %s, I am %d years old.'.sprintf('John', 'Doe', 46);
   */
  sprintf(...params: any[]): string;

  /**
   * @description Determines if the string instance starts with another string.
   * @method startsWith
   * @memberof String
   * @param suffix {String} The string to check for.
   * @returns {boolean} True if string instance starts with the preffix string. False otherwise.
   * @example var startsWith = 'string'.startsWith('st');
   */
   startsWith(suffix: string): boolean;

  /**
   * @description Creates a copy of the current string converted to camel case
   * based on word breaks. The words may be separated with dash, underscore,
   * period, or space.
   * @method toCamelCase
   * @memberof String.prototype
   * @returns {String} The current string converted to camel case.
   * @example 'hello_world'.toCamelCase();
   */
  toCamelCase(): string;

  /**
   * @description Creates a copy of the current string converted to title case.
   * @method toTitleCase
   * @memberof String.prototype
   * @returns {String} The current string converted to title case.
   * @example 'hello world'.toTitleCase();
   */
  toTitleCase():string;
}

interface StringConstructor {
  /**
   * @description An empty string.
   * @constant EMPTY
   * @type {String}
   * @memberof String
   */
  EMPTY: string;

  /**
   * @description Compares two strings for equality.
   * @method equals
   * @memberof String
   * @param str {String} The first string to compare.
   * @param other {String} The second string to compare.
   * @returns {boolean} True if strings are equal. False otherwise.
   * @example var isEqual = String.equals('string', 'string');
   */
  equals(str: string, other: string): boolean;

  /**
   * @description Determines if a string ends with another string.
   * @method endsWith
   * @memberof String
   * @param str {String} The string to check.
   * @param suffix {String} The string to check for.
   * @returns {boolean} True if string ends with the suffix string. False otherwise.
   * @example var endsWith = String.endsWith('string', 'ng');
   */
  endsWith(str: string, suffix: string): boolean;

  /**
   * @description Formats a string using numbered tokens e.g. 'Format string {0}, {1}, {2}'.
   * @method format
   * @memberof String
   * @param format {String} The format for the string.
   * @param params {...*} One or more parameters to format into the format string.
   * @returns {String} The formatted string.
   * @example String.format('Hello, my name is {0} {1}.', 'John', 'Doe');
   */
  format(format: string, ...params: any[]): string;

  /**
   * @description Generate a password.
   * @method generatePassword
   * @memberof String
   * @param length {int} Length of the new password.
   * @param inclNumbers {boolean} Whether to include numbers in the new password.
   * @param inclSymbols {boolean} Whether to include symbols in the new password.
   * @returns {string} A new randomly generated password.
   */
  generatePassword(length: number, inclNumbers: boolean, inclSymbols: boolean): string;

  /**
   * @description Generates a hashcode for the current string.
   * @method hashCode
   * @memberof String.prototype
   * @returns {String} The hashcode for the current string.
   * @example 'Hello World'.hashCode();
   */
  hashCode(): number;

  /**
   * @description Determine if a string is null, undefined, or zero length.
   * @method isNullOrEmpty
   * @memberof String
   * @param str {String} The string to check.
   * @returns {boolean} True if null, undefined, or zero length. False otherwise.
   */
  isNullOrEmpty(str: string): boolean;

  /**
   * @description Creates a copy of the current string with the leading whitespace
   * removed.
   * @method ltrim
   * @memberof String
   * @param str {String} The string to trim.
   * @returns {String} The current string with the leading spaces removed.
   * @example String.ltrim('   Hello World');
   */
  ltrim(str: string): string;

  /**
   * @description Generates a MD5 message digest for the current string instance.
   * @method md5
   * @memberof String.prototype
   * @param str {String} The string to compute digest.
   * @returns {String} The MD5 message digest for the current string instance.
   * @example String.md5('password');
   */
  md5(str: string): string;

  /**
   * @description Prints a formatted string.
   * @method print
   * @memberof String
   * @param format {String} The format for the string.
   * @param params {...*} One or more parameters to format into the format string.
   * @example String.print('Hello, my name is {0} {1}.', 'John', 'Doe');
   * @see String.format
   */
  print(format: string, ...params: any[]): void;

  /**
   * @description Prints a formatted string.
   * @method printf
   * @memberof String
   * @param format {String} The format for the string.
   * @param params {...*} One or more parameters to format into the format string.
   * @example String.printf('Hello, my name is %s %s, I am %d years old.', 'John', 'Doe', 46);
   * @see String.sprintf
   */
  printf(format: string, ...params: any[]): void;

  /**
   * @description Creates a copy of the current string with the trailing whitespace
   * removed.
   * @method rtrim
   * @memberof String
   * @param str {String} The string to trim.
   * @returns {String} The current string with the trailing spaces removed.
   * @example String.rtrim('Hello World   ');
   */
  rtrim(str: string): string;

  /**
   * @description Formats a string using tokens e.g. 'Format string %s, %d, %f'.
   * @method sprintf
   * @memberof String
   * @param format
   * The format string is composed of zero or more directives: ordinary characters (excluding %)
   * that are copied directly to the result, and conversion specifications, each of which results
   * in fetching its own parameter.<br/>
   * <br/>
   * Each conversion specification consists of a percent sign (%), followed by one or more of
   * these elements, in order:<br/>
   * <br/>
   * <ol style="padding-left: 20px;">
   *   <li>
   *   An optional sign specifier that forces a sign (- or +) to be used on a number. By default,
   *   only the - sign is used on a number if it's negative. This specifier forces positive numbers
   *   to have the + sign attached as well.
   *   </li>
   *   <li>
   *   An optional padding specifier that says what character will be used for padding the results
   *   to the right string size. This may be a space character or a 0 (zero character). The default
   *   is to pad with spaces. An alternate padding character can be specified by prefixing it with
   *   a single quote (').
   *   </li>
   *   <li>
   *   An optional alignment specifier that says if the result should be left-justified or
   *   right-justified. The default is right-justified; a - character here will make it left-justified.
   *   </li>
   *   <li>
   *   An optional number, a width specifier that says how many characters (minimum) this conversion
   *   should result in.
   *   </li>
   *   <li>
   *   An optional precision specifier in the form of a period (`.') followed by an optional
   *   decimal digit string that says how many decimal digits should be displayed for floating-point numbers.
   *   When using this specifier on a string, it acts as a cutoff point, setting a maximum character limit
   *   to the string.
   *   </li>
   *   <li>
   *     A type specifier that says what type the argument data should be treated as.
   *   </li>
   * </ol>
   * <span style="font-weight: bold; padding-left: 20px;">Possible types:</span>
   * <ul>
   *   <li>% - a literal percent character. No argument is required.</li>
   *   <li>b - the argument is treated as an integer, and presented as a binary number.</li>
   *   <li>c - the argument is treated as an integer, and presented as the character with that ASCII value.</li>
   *   <li>d - the argument is treated as an integer, and presented as a (signed) decimal number.</li>
   *   <li>e - the argument is treated as scientific notation (e.g. 1.2e+2). The precision specifier stands
   *     for the number of digits after the decimal point.</li>
   *   <li>E - like %e but uses uppercase letter (e.g. 1.2E+2).</li>
   *   <li>f - the argument is treated as a float, and presented as a floating-point number (locale aware).</li>
   *   <li>F - the argument is treated as a float, and presented as a floating-point number (non-locale aware).</li>
   *   <li>g - shorter of %e and %f.</li>
   *   <li>G - shorter of %E and %f.</li>
   *   <li>o - the argument is treated as an integer, and presented as an octal number.</li>
   *   <li>s - the argument is treated as and presented as a string.</li>
   *   <li>u - the argument is treated as an integer, and presented as an unsigned decimal number.</li>
   *   <li>x - the argument is treated as an integer and presented as a hexadecimal number (with lowercase letters).</li>
   *   <li>X - the argument is treated as an integer and presented as a hexadecimal number (with uppercase letters).</li>
   * </ul>
   * @param params {...*} One or more parameters to format into the format string.
   * @returns {String} The formatted string.
   */
  sprintf(format: string, ...params: any[]): string;

  /**
   * @description Determines if the string starts with another string.
   * @method startsWith
   * @memberof String
   * @param str {String} The string to check.
   * @param suffix {String} The string to check for.
   * @returns {boolean} True if string starts with the preffix string. False otherwise.
   * @example var startsWith = String.startsWith('string', 'st');
   */
  startsWith(str: string, preffix: string):boolean;
  
  /**
   * @description Converts a string to a boolean.
   * @method toBoolean
   * @memberof String
   * @param str {String} The string to convert to boolean.
   * @returns {boolean} True if the string is 'true' or 'yes'. False otherwise.
   * @example var isTrue = String.toBoolean('true');
   */
  toBoolean(str: string): boolean;

  /**
   * @description Creates a copy of a string converted to camel case
   * based on word breaks. The words may be separated with dash, underscore,
   * period, or space.
   * @method toCamelCase
   * @memberof String.prototype
   * @param str {String} The string to convert to camel case.
   * @returns {String} The current string converted to camel case.
   * @example String.toCamelCase('hello_world');
   */
  toCamelCase(str: string): string;

  /**
   * @description Creates a copy of a string converted to title case.
   * @method toTitleCase
   * @memberof String.prototype
   * @param str {String} The string to convert to title case.
   * @returns {String} The current string converted to title case.
   * @example String.toTitleCase('hello world');
   */
  toTitleCase(str: string):string;
}

declare var String: StringConstructor;

interface JSON {
  safeStringify(str: string, replacer?: Function|number, spaces?: number|Function, cycleRepeater?: Function): string;
  serializer(replacer?: Function, cycleRepeater?: Function): Function;
}