snake

将字符串转换为下划线分隔的格式（snake_case）。

基础用法

typescript

import { snake } from 'radash'

console.log(snake('hello world'))        // 'hello_world'
console.log(snake('HelloWorld'))         // 'hello_world'
console.log(snake('hello-world'))        // 'hello_world'
console.log(snake('helloWorld'))         // 'hello_world'

语法

typescript

function snake(str: string): string

参数

str (string): 要转换的字符串

返回值

返回转换为下划线分隔格式的字符串。

示例

基本转换

typescript

import { snake } from 'radash'

console.log(snake('hello world'))        // 'hello_world'
console.log(snake('Hello World'))        // 'hello_world'
console.log(snake('HELLO WORLD'))        // 'hello_world'
console.log(snake('helloWorld'))         // 'hello_world'
console.log(snake('HelloWorld'))         // 'hello_world'
console.log(snake('hello_world'))        // 'hello_world'
console.log(snake('hello-world'))        // 'hello_world'

处理特殊字符

typescript

import { snake } from 'radash'

console.log(snake('hello.world'))        // 'hello_world'
console.log(snake('hello@world'))        // 'hello_world'
console.log(snake('hello#world'))        // 'hello_world'
console.log(snake('hello$world'))        // 'hello_world'
console.log(snake('hello%world'))        // 'hello_world'
console.log(snake('hello^world'))        // 'hello_world'
console.log(snake('hello&world'))        // 'hello_world'

处理数字

typescript

import { snake } from 'radash'

console.log(snake('hello123world'))      // 'hello123_world'
console.log(snake('123hello456world'))   // '123_hello456_world'
console.log(snake('hello123'))           // 'hello123'
console.log(snake('123hello'))           // '123_hello'

处理连续分隔符

typescript

import { snake } from 'radash'

console.log(snake('hello   world'))      // 'hello_world'
console.log(snake('hello___world'))      // 'hello_world'
console.log(snake('hello---world'))      // 'hello_world'
console.log(snake('hello...world'))      // 'hello_world'

处理边界情况

typescript

import { snake } from 'radash'

console.log(snake(''))                   // ''
console.log(snake('hello'))              // 'hello'
console.log(snake('   hello   '))        // 'hello'
console.log(snake('HELLO'))              // 'hello'
console.log(snake('hello_world'))        // 'hello_world'

处理复杂字符串

typescript

import { snake } from 'radash'

console.log(snake('UserProfileComponent'))    // 'user_profile_component'
console.log(snake('APIResponseData'))         // 'api_response_data'
console.log(snake('HTTPStatusCode'))          // 'http_status_code'
console.log(snake('JSONWebToken'))            // 'json_web_token'
console.log(snake('CSSGridLayout'))           // 'css_grid_layout'

处理文件名

typescript

import { snake } from 'radash'

console.log(snake('userProfile.js'))         // 'user_profile_js'
console.log(snake('UserProfile.tsx'))        // 'user_profile_tsx'
console.log(snake('api_response.json'))      // 'api_response_json'
console.log(snake('config_file.yaml'))       // 'config_file_yaml'

处理CSS类名

typescript

import { snake } from 'radash'

console.log(snake('userProfile'))            // 'user_profile'
console.log(snake('userProfileActive'))      // 'user_profile_active'
console.log(snake('userProfileContainer'))   // 'user_profile_container'
console.log(snake('userProfileHeader'))      // 'user_profile_header'

处理数据库字段名

typescript

import { snake } from 'radash'

console.log(snake('userName'))               // 'user_name'
console.log(snake('firstName'))              // 'first_name'
console.log(snake('lastName'))               // 'last_name'
console.log(snake('emailAddress'))           // 'email_address'
console.log(snake('phoneNumber'))            // 'phone_number'
console.log(snake('createdAt'))              // 'created_at'
console.log(snake('updatedAt'))              // 'updated_at'

处理API端点

typescript

import { snake } from 'radash'

console.log(snake('getUserProfile'))         // 'get_user_profile'
console.log(snake('updateUserSettings'))     // 'update_user_settings'
console.log(snake('deleteUserAccount'))      // 'delete_user_account'
console.log(snake('createNewPost'))          // 'create_new_post'
console.log(snake('fetchUserData'))          // 'fetch_user_data'

处理组件名

typescript

import { snake } from 'radash'

console.log(snake('UserProfile'))            // 'user_profile'
console.log(snake('UserProfileCard'))        // 'user_profile_card'
console.log(snake('UserProfileHeader'))      // 'user_profile_header'
console.log(snake('UserProfileFooter'))      // 'user_profile_footer'
console.log(snake('UserProfileContent'))     // 'user_profile_content'

处理事件名

typescript

import { snake } from 'radash'

console.log(snake('onClick'))                // 'on_click'
console.log(snake('onSubmit'))               // 'on_submit'
console.log(snake('onChange'))               // 'on_change'
console.log(snake('onFocus'))                // 'on_focus'
console.log(snake('onBlur'))                 // 'on_blur'
console.log(snake('onKeyDown'))              // 'on_key_down'
console.log(snake('onMouseEnter'))           // 'on_mouse_enter'

处理配置键

typescript

import { snake } from 'radash'

console.log(snake('apiBaseUrl'))             // 'api_base_url'
console.log(snake('databaseConnection'))     // 'database_connection'
console.log(snake('redisCache'))             // 'redis_cache'
console.log(snake('sessionTimeout'))         // 'session_timeout'
console.log(snake('maxRetryAttempts'))      // 'max_retry_attempts'

处理URL路径

typescript

import { snake } from 'radash'

console.log(snake('userProfile'))            // 'user_profile'
console.log(snake('userSettings'))           // 'user_settings'
console.log(snake('userDashboard'))          // 'user_dashboard'
console.log(snake('userNotifications'))      // 'user_notifications'
console.log(snake('userPreferences'))        // 'user_preferences'

处理HTML属性

typescript

import { snake } from 'radash'

console.log(snake('dataUserId'))             // 'data_user_id'
console.log(snake('ariaLabel'))              // 'aria_label'
console.log(snake('ariaDescribedby'))       // 'aria_describedby'
console.log(snake('ariaLabelledby'))        // 'aria_labelledby'
console.log(snake('ariaHidden'))             // 'aria_hidden'

处理CSS属性

typescript

import { snake } from 'radash'

console.log(snake('backgroundColor'))        // 'background_color'
console.log(snake('borderRadius'))           // 'border_radius'
console.log(snake('fontSize'))               // 'font_size'
console.log(snake('lineHeight'))             // 'line_height'
console.log(snake('textAlign'))              // 'text_align'
console.log(snake('marginTop'))              // 'margin_top'
console.log(snake('paddingLeft'))            // 'padding_left'

处理JavaScript变量

typescript

import { snake } from 'radash'

console.log(snake('userName'))               // 'user_name'
console.log(snake('firstName'))              // 'first_name'
console.log(snake('lastName'))               // 'last_name'
console.log(snake('emailAddress'))           // 'email_address'
console.log(snake('phoneNumber'))            // 'phone_number'
console.log(snake('isActive'))               // 'is_active'
console.log(snake('hasPermission'))          // 'has_permission'

处理常量名

typescript

import { snake } from 'radash'

console.log(snake('API_BASE_URL'))          // 'api_base_url'
console.log(snake('MAX_RETRY_ATTEMPTS'))    // 'max_retry_attempts'
console.log(snake('DEFAULT_TIMEOUT'))       // 'default_timeout'
console.log(snake('USER_ROLE_ADMIN'))       // 'user_role_admin'
console.log(snake('SESSION_TOKEN_KEY'))     // 'session_token_key'

处理枚举值

typescript

import { snake } from 'radash'

console.log(snake('UserStatusActive'))       // 'user_status_active'
console.log(snake('UserStatusInactive'))    // 'user_status_inactive'
console.log(snake('UserRoleAdmin'))         // 'user_role_admin'
console.log(snake('UserRoleUser'))          // 'user_role_user'
console.log(snake('UserRoleGuest'))         // 'user_role_guest'

处理类型名

typescript

import { snake } from 'radash'

console.log(snake('UserProfile'))            // 'user_profile'
console.log(snake('UserSettings'))           // 'user_settings'
console.log(snake('ApiResponse'))            // 'api_response'
console.log(snake('DatabaseConnection'))     // 'database_connection'
console.log(snake('HttpStatusCode'))         // 'http_status_code'

处理接口名

typescript

import { snake } from 'radash'

console.log(snake('IUserProfile'))           // 'i_user_profile'
console.log(snake('IUserSettings'))          // 'i_user_settings'
console.log(snake('IApiResponse'))           // 'i_api_response'
console.log(snake('IDatabaseConnection'))    // 'i_database_connection'
console.log(snake('IHttpStatusCode'))        // 'i_http_status_code'

处理函数名

typescript

import { snake } from 'radash'

console.log(snake('getUserProfile'))         // 'get_user_profile'
console.log(snake('updateUserSettings'))     // 'update_user_settings'
console.log(snake('deleteUserAccount'))      // 'delete_user_account'
console.log(snake('createNewPost'))          // 'create_new_post'
console.log(snake('fetchUserData'))          // 'fetch_user_data'
console.log(snake('validateUserInput'))      // 'validate_user_input'

处理类名

typescript

import { snake } from 'radash'

console.log(snake('UserProfileService'))     // 'user_profile_service'
console.log(snake('UserSettingsController')) // 'user_settings_controller'
console.log(snake('ApiResponseHandler'))     // 'api_response_handler'
console.log(snake('DatabaseConnectionPool')) // 'database_connection_pool'
console.log(snake('HttpStatusCodeMapper'))   // 'http_status_code_mapper'

处理数据库表名

typescript

import { snake } from 'radash'

console.log(snake('UserProfile'))            // 'user_profile'
console.log(snake('UserSettings'))           // 'user_settings'
console.log(snake('ApiResponse'))            // 'api_response'
console.log(snake('DatabaseConnection'))     // 'database_connection'
console.log(snake('HttpStatusCode'))         // 'http_status_code'

处理API响应字段

typescript

import { snake } from 'radash'

console.log(snake('responseData'))           // 'response_data'
console.log(snake('errorMessage'))           // 'error_message'
console.log(snake('statusCode'))             // 'status_code'
console.log(snake('requestId'))              // 'request_id'
console.log(snake('timestamp'))              // 'timestamp'

处理环境变量

typescript

import { snake } from 'radash'

console.log(snake('NODE_ENV'))               // 'node_env'
console.log(snake('DATABASE_URL'))           // 'database_url'
console.log(snake('API_KEY'))                // 'api_key'
console.log(snake('SECRET_TOKEN'))           // 'secret_token'
console.log(snake('REDIS_HOST'))             // 'redis_host'

处理文件名转换

typescript

import { snake } from 'radash'

function convertFileName(fileName: string): string {
  return snake(fileName.replace(/\.[^/.]+$/, '')) // 移除扩展名
}

console.log(convertFileName('UserProfile.tsx'))     // 'user_profile'
console.log(convertFileName('apiResponse.json'))    // 'api_response'
console.log(convertFileName('configFile.yaml'))     // 'config_file'
console.log(convertFileName('index.js'))            // 'index'

处理变量名转换

typescript

import { snake } from 'radash'

function convertVariableName(varName: string): string {
  return snake(varName)
}

console.log(convertVariableName('userName'))         // 'user_name'
console.log(convertVariableName('firstName'))        // 'first_name'
console.log(convertVariableName('emailAddress'))     // 'email_address'
console.log(convertVariableName('phoneNumber'))      // 'phone_number'

注意事项

大小写转换: 所有字符都会转换为小写
分隔符处理: 空格、连字符、点号等都会被转换为下划线
连续分隔符: 多个连续的分隔符会被合并为单个下划线
边界处理: 开头和结尾的分隔符会被移除
特殊字符: 非字母数字字符会被转换为下划线

与其他方法的区别

camel(): 转换为驼峰命名法
pascal(): 转换为帕斯卡命名法
dash(): 转换为短横线分隔格式
snake(): 转换为下划线分隔格式

实际应用场景

数据库字段名: 生成数据库字段名
API参数名: 生成API参数名
配置文件键名: 生成配置文件中的键名
文件名: 生成文件名
变量名: 生成变量名

snake ​

基础用法 ​

语法 ​

参数 ​

返回值 ​

示例 ​

基本转换 ​

处理特殊字符 ​

处理数字 ​

处理连续分隔符 ​

处理边界情况 ​

处理复杂字符串 ​

处理文件名 ​

处理CSS类名 ​

处理数据库字段名 ​

处理API端点 ​

处理组件名 ​

处理事件名 ​

处理配置键 ​

处理URL路径 ​

处理HTML属性 ​

处理CSS属性 ​

处理JavaScript变量 ​

处理常量名 ​

处理枚举值 ​

处理类型名 ​

处理接口名 ​

处理函数名 ​

处理类名 ​

处理数据库表名 ​

处理API响应字段 ​

处理环境变量 ​

处理文件名转换 ​

处理变量名转换 ​

注意事项 ​

与其他方法的区别 ​

实际应用场景 ​

snake

基础用法

语法

参数

返回值

示例

基本转换

处理特殊字符

处理数字

处理连续分隔符

处理边界情况

处理复杂字符串

处理文件名

处理CSS类名

处理数据库字段名

处理API端点

处理组件名

处理事件名

处理配置键

处理URL路径

处理HTML属性

处理CSS属性

处理JavaScript变量

处理常量名

处理枚举值

处理类型名

处理接口名

处理函数名

处理类名

处理数据库表名

处理API响应字段

处理环境变量

处理文件名转换

处理变量名转换

注意事项

与其他方法的区别

实际应用场景