typescript-closure-tools/index/closure-library/closure/goog/i18n/collation.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />

declare module goog.i18n.collation {

    /**
     * Returns the comparator for a locale. If a locale is not explicitly specified,
     * a comparator for the user's locale will be returned. Note that if the browser
     * does not support locale-sensitive string comparisons, the comparator returned
     * will be a simple codepoint comparator.
     *
     * @param {string=} opt_locale the locale that the comparator is used for.
     * @return {function(string, string): number} The locale-specific comparator.
     */
    function createComparator(opt_locale?: string): { (_0: string, _1: string): number };

    /**
     * Returns true if a locale-sensitive comparator is available for a locale. If
     * a locale is not explicitly specified, the user's locale is used instead.
     *
     * @param {string=} opt_locale The locale to be checked.
     * @return {boolean} Whether there is a locale-sensitive comparator available
     *     for the locale.
     */
    function hasNativeComparator(opt_locale?: string): boolean;
}