snake

Converts a string to underscore-separated format (snake_case).

Basic Usage

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'

Syntax

function snake(str: string): string

Parameters

• str (string): The string to convert

Return Value

Returns a string converted to underscore-separated format.

Examples

Basic Conversion

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'

Handling Special Characters

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'

Handling Numbers

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'

Handling Consecutive Delimiters

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'

Handling Edge Cases

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'

Handling Complex Strings

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'

Handling File Names

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'

Handling CSS Class Names

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'

Handling Database Field Names

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'

Handling API Endpoints

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'

Handling Component Names

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'

Handling Event Names

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'

Handling Configuration Keys

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'

Handling URL Paths

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'

Handling HTML Attributes

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'

Handling CSS Properties

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'

Handling JavaScript Variables

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'

Handling Constant Names

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'

Handling Enum Values

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'

Handling Type Names

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'

Handling Interface Names

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'

Handling Function Names

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'

Handling Class Names

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'

Handling Database Table Names

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'

Handling API Response Fields

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'

Handling Environment Variables

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'

Handling File Name Conversion

import { snake } from 'radash'

function convertFileName(fileName: string): string {
  return snake(fileName.replace(/\.[^/.]+$/, '')) // Remove extension
}

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'

Handling Variable Name Conversion

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'

Notes

1. Case Conversion: All characters are converted to lowercase
2. Delimiter Processing: Spaces, hyphens, dots, etc. are all converted to underscores
3. Consecutive Delimiters: Multiple consecutive delimiters are merged into a single underscore
4. Boundary Processing: Delimiters at the beginning and end are removed
5. Special Characters: Non-alphanumeric characters are converted to underscores

Differences from Other Methods

• camel(): Converts to camel case
• pascal(): Converts to Pascal case
• dash(): Converts to dash-separated format
• snake(): Converts to underscore-separated format

Practical Application Scenarios

1. Database Field Names: Generate database field names
2. API Parameter Names: Generate API parameter names
3. Configuration File Keys: Generate keys in configuration files
4. File Names: Generate file names
5. Variable Names: Generate variable names