@mdf.js/utils/dist/camelCase/Options.i.d.ts

MMS - API Core - Common utils tools

/**
 * Copyright 2024 Mytra Control S.L. All rights reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
 * or at https://opensource.org/licenses/MIT.
 */
export interface Options {
    /**
     * Uppercase the first character: `foo-bar` → `FooBar`.
     * @defaultValue false
     */
    readonly pascalCase?: boolean;
    /**
     * Preserve consecutive uppercase characters: `foo-BAR` → `fooBAR`.
     * @defaultValue false
     */
    readonly preserveConsecutiveUppercase?: boolean;
    /**
     * The locale parameter indicates the locale to be used to convert to upper/lower case according
     * to any locale-specific case mappings. If multiple locales are given in an array, the best
     * available locale is used.
     * Setting `locale: false` ignores the platform locale and uses the
     * [Unicode Default Case Conversion](https://unicode-org.github.io/icu/userguide/transforms/casemappings.html#simple-single-character-case-mapping)
     * algorithm.
     * Default: The host environment’s current locale.
     * @example
     * ```ts
     * import { camelCase } from 'camelCase';
     * camelCase('lorem-ipsum', {locale: 'en-US'});
     * //=> 'loremIpsum'
     * camelCase('lorem-ipsum', {locale: 'tr-TR'});
     * //=> 'loremİpsum'
     * camelCase('lorem-ipsum', {locale: ['en-US', 'en-GB']});
     * //=> 'loremIpsum'
     * camelCase('lorem-ipsum', {locale: ['tr', 'TR', 'tr-TR']});
     * //=> 'loremİpsum'
     * ```
     */
    readonly locale?: string | string[];
}
//# sourceMappingURL=Options.i.d.ts.map