# snake

URL: https://caijiao.org/radash/string/snake
Source: docs/radash/string/snake.md
Description: 将字符串转换为蛇形命名格式 给定一个字符串，以蛇形命名格式返回它

将字符串转换为蛇形命名格式


## 基本用法

给定一个字符串，以蛇形命名格式返回它。

```ts
import { snake } from 'radash'

snake('green fish blue fish') // => green_fish_blue_fish
```

**警告**: 在 v11.0.0 版本中，对该函数进行了修改以正确地将数字与相邻字母分开（`hello5` 变为 `hello_5`）。你可以通过传递 `splitOnNumber` 选项来选择退出此行为并继续使用旧版风格（`hello5` 保持 `hello5`）。

```ts
snake('5green fish 2blue fish') // => 5_green_fish_2_blue_fish

snake('5green fish 2blue fish', {
    splitOnNumber: false
}) // => 5green_fish_2blue_fish
```