https://github.com/firede/case-it

{🐫camel,🔆constant,💠dot,🍢kebab,👍pascal,🐍snake,👾space} case it.
https://github.com/firede/case-it

camelcase case flow pascalcase snakecase typescript utility

Last synced: 2 months ago
JSON representation

{🐫camel,🔆constant,💠dot,🍢kebab,👍pascal,🐍snake,👾space} case it.

• Host: GitHub
• URL: https://github.com/firede/case-it
• Owner: firede
• License: other
• Created: 2018-05-16T18:01:06.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:25:00.000Z (almost 2 years ago)
• Last Synced: 2024-10-30T12:53:09.958Z (2 months ago)
• Topics: camelcase, case, flow, pascalcase, snakecase, typescript, utility
• Language: TypeScript
• Homepage:
• Size: 1.36 MB
• Stars: 38
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# [![case-it](res/header.png)](https://github.com/firede/case-it)

[![npm](https://img.shields.io/npm/v/case-it.svg)](https://www.npmjs.com/package/case-it)

![ci workflow](https://github.com/firede/case-it/actions/workflows/ci.yml/badge.svg)

[![License](https://img.shields.io/npm/l/case-it.svg)](./LICENSE.md)

![npm bundle size(minified)](https://img.shields.io/bundlephobia/min/case-it.svg)

![npm bundle size(minified + gzip)](https://img.shields.io/bundlephobia/minzip/case-it.svg)

Simple case conversion for strings, ported from [`to-case`](https://github.com/ianstormtaylor/to-case).

## Features

- Official support type definitions - both TypeScript and Flowtype.

- Single package, separate modules - easy to use, tiny bundles.

- No unnecessary detection tools - Just use `str === caseIt(str)`.

- Zero dependencies.

## Installation

```sh

npm install case-it

```

## Usage

Import:

```js

// Import by the main module

const { camelCaseIt } = require("case-it")

// Using the `import` statement (TypeScript, Babel, etc.)

import { dotCaseIt } from "case-it"

// Or just import the modules you need

const { constantCaseIt } = require("case-it/constant")

```

Case conversion:

```js

camelCaseIt("THIS_IS_A_STRING")   // "thisIsAString"

constantCaseIt("thisIsAString")   // "THIS_IS_A_STRING"

dotCaseIt("thisIsAString")        // "this.is.a.string"

kebabCaseIt("ThisIsAString")      // "this-is-a-string"

noCaseIt("thisIsAString")         // "this is a string"

pascalCaseIt("this is a string")  // "ThisIsAString"

snakeCaseIt("THIS_IS_A_STRING")   // "this_is_a_string"

spaceCaseIt("this_is_a_string")   // "this is a string"

```

Case detection:

```js

const str = "THIS_IS_A_STRING"

const strIsCamel = str === camelCaseIt(str)       // false

const strIsConstant = str === constantCaseIt(str) // true

```

## API

### `camelCaseIt(str: string): string`

Convert a `string` to camel case. (`"case-it/camel"`)

### `constantCaseIt(str: string): string`

Convert a `string` to constant case. (`"case-it/constant"`)

### `dotCaseIt(str: string): string`

Convert a `string` to dot case. (`"case-it/dot"`)

### `kebabCaseIt(str: string): string`

Convert a `string` to kebab case. (`"case-it/kebab"`)

### `noCaseIt(str: string): string`

Remove any starting case from a `string`, like camel or snake, but keep spaces and punctuation that may be important otherwise. (`"case-it/no"`)

### `pascalCaseIt(str: string): string`

Convert a `string` to pascal case. (`"case-it/pascal"`)

### `snakeCaseIt(str: string): string`

Convert a `string` to snake case. (`"case-it/snake"`)

### `spaceCaseIt(str: string): string`

Convert a `string` to space case. (`"case-it/space"`)

## License

### `case-it`

[The MIT License (MIT)](./LICENSE.md#case-it) - Copyright (c) 2018-present, Firede

### `to-case`

[The MIT License (MIT)](./LICENSE.md#to-case) - Copyright (c) 2016, Ian Storm Taylor