mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
abdecb30b7
* feat(text): added toConstantCase * move to to_constant_case.ts * mark as unstable API * fix import in example * unstable notice --------- Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com> Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
31 lines
839 B
TypeScript
31 lines
839 B
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
import { splitToWords } from "./_util.ts";
|
|
|
|
/**
|
|
* Converts a string into CONSTANT_CASE (also known as SCREAMING_SNAKE_CASE).
|
|
*
|
|
* > [!WARNING]
|
|
* > **UNSTABLE**: New API, yet to be vetted.
|
|
*
|
|
* @experimental
|
|
*
|
|
* @example Usage
|
|
* ```ts
|
|
* import { toConstantCase } from "@std/text/to-constant-case";
|
|
* import { assertEquals } from "@std/assert/equals";
|
|
*
|
|
* assertEquals(toConstantCase("deno is awesome"), "DENO_IS_AWESOME");
|
|
* ```
|
|
*
|
|
* @param input The string that is going to be converted into CONSTANT_CASE
|
|
* @returns The string as CONSTANT_CASE
|
|
*
|
|
* @experimental
|
|
*/
|
|
export function toConstantCase(input: string): string {
|
|
input = input.trim();
|
|
return splitToWords(input).join("_").toLocaleUpperCase();
|
|
}
|