On this page
Naming Conventions
We write functions, not variables. Function names must explain what the function does.
Rules
- Always use camelCase
- No shortcuts or abbreviations
- Names must be descriptive and self-explanatory
Function Names
✅ Good:
const getUsersByAge = (users: User[], minAge: number) => ...
const calculateAveragePrice = (products: Product[]) => ...
const filterActiveSubscriptions = (subscriptions: Subscription[]) => ...
❌ Avoid:
const getUsersByAge = (u: User[], a: number) => ... // Abbreviations
const calc = (products: Product[]) => ... // Too short
const doFilter = (subs: Subscription[]) => ... // Vague, abbreviation
Variable Names (when necessary)
The same rules apply if you must use a variable:
✅ Good:
const activeUsers = getActiveUsers(db)
const totalRevenue = calculateTotalRevenue(orders)
❌ Avoid:
const au = getActiveUsers(db) // Abbreviation
const x = calculateTotalRevenue(orders) // Single letter
const data = getActiveUsers(db) // Too generic
Good function names eliminate the need for comments. See Documentation Through Code for more details.