The underscore convention for defining members in Typescript allows for clear and concise

Question

The underscore convention for defining members in Typescript allows for clear and concise

Let's talk about a class called Email

class Email {
  private _from: string;
  private _to: Array<string>;
  private _subject: string;
}

When an email object is created, it will look something like this:

{
  _from:'',
  _to:'',
  _subject:''
}

I find it strange that I can't directly use this object to send to a function. It seems like I'll need to transform the object so that it doesn't have underscores. Do I really have to do this or is there a way to use the underscore convention as is?

EDIT: Removing the _

If we name the private variables without underscore, how should we name the getters and setters? A VSCode plugin called Typescript toolbox suggests using something like this:

public get $subject(): string { 
  return this.subject;
}

Is using $ as a prefix for getters a good convention?

javascript typescript ecmascript-6 typescript2.0 es6-class

Answer 1

Answer №1

In discussions about naming conventions, some argue against using the "_" character. Here is an example code snippet from the TypeScript site to illustrate this:

class Employee {
    private _fullName: string;

    get fullName(): string {
        return this._fullName;
    } 
    this._fullName = ......
}

A similar question can be found on Stackoverflow, where you may find some helpful insights.

If we refrain from using _, what alternative naming schemes could be more effective?

For instance, consider the case of an email property. Without _, the naming convention might look like this:

member: to,      get/set: emailTo
member: from     get/set: emailFrom

You might suggest better names, but constantly having to rethink these decisions can be cumbersome for developers.

While using _ can simplify code readability by directly linking properties and members, avoiding it means maintaining a mapping between the two.

However: If your company mandates no use of _, consider using $ as a substitute for both member and property names:

class Employee {
    private fullName$: string;

    get fullName(): string {
        return this.fullName$;
    } 
    this.fullName$ = ......
}

The ultimate decision rests with you!

Answer 2

In discussions about naming conventions, some argue against using the "_" character. Here is an example code snippet from the TypeScript site to illustrate this:

class Employee {
    private _fullName: string;

    get fullName(): string {
        return this._fullName;
    } 
    this._fullName = ......
}

A similar question can be found on Stackoverflow, where you may find some helpful insights.

If we refrain from using _, what alternative naming schemes could be more effective?

For instance, consider the case of an email property. Without _, the naming convention might look like this:

member: to,      get/set: emailTo
member: from     get/set: emailFrom

You might suggest better names, but constantly having to rethink these decisions can be cumbersome for developers.

While using _ can simplify code readability by directly linking properties and members, avoiding it means maintaining a mapping between the two.

However: If your company mandates no use of _, consider using $ as a substitute for both member and property names:

class Employee {
    private fullName$: string;

    get fullName(): string {
        return this.fullName$;
    } 
    this.fullName$ = ......
}

The ultimate decision rests with you!

Answer 3

Answer №2

Avoid using "_" as a prefix for private fields, as it is considered an outdated style. It is recommended to choose variable names that are clear and easily understandable.

For more information on coding conventions, refer to the Microsoft TypeScript coding guidelines here

Do not use "_" as a prefix for private properties.

Answer 4

Avoid using "_" as a prefix for private fields, as it is considered an outdated style. It is recommended to choose variable names that are clear and easily understandable.

For more information on coding conventions, refer to the Microsoft TypeScript coding guidelines here

Do not use "_" as a prefix for private properties.

Answer 5

Answer №3

Feel free to choose your own names for private variables without relying on _. You have the freedom to establish and adhere to your own naming standards.

Remember, setters and getters are considered regular functions, so it is important to maintain consistency in method naming conventions.

Avoid using ""_" as a prefix for private properties.
Whenever possible, use complete words in variable names.

Note that this recommendation is subjective, and you have the flexibility to include _ if necessary.

Additional tip: Consider using $ as a prefix for variable names, especially when dealing with observables (like rxJS) in your daily coding tasks.

Edit:

If you encounter conflicts with getter functions, incorporating _ into field names can help mitigate potential issues.

Answer 6

Feel free to choose your own names for private variables without relying on _. You have the freedom to establish and adhere to your own naming standards.

Remember, setters and getters are considered regular functions, so it is important to maintain consistency in method naming conventions.

Avoid using ""_" as a prefix for private properties.
Whenever possible, use complete words in variable names.

Note that this recommendation is subjective, and you have the flexibility to include _ if necessary.

Additional tip: Consider using $ as a prefix for variable names, especially when dealing with observables (like rxJS) in your daily coding tasks.

Edit:

If you encounter conflicts with getter functions, incorporating _ into field names can help mitigate potential issues.

Answer 7

Answer №4

Avoid using underscores as a prefix or suffix in variable names, as this practice is generally considered suboptimal.

For more information, refer to the Google Typescript Style Guide. Unlike the Microsoft Style Guide mentioned in another response, this guide offers specific recommendations on coding style.

_ prefix/suffix: Identifiers should not start or end with _

Visit for further details.

Answer 8

Avoid using underscores as a prefix or suffix in variable names, as this practice is generally considered suboptimal.

For more information, refer to the Google Typescript Style Guide. Unlike the Microsoft Style Guide mentioned in another response, this guide offers specific recommendations on coding style.

_ prefix/suffix: Identifiers should not start or end with _

Visit for further details.

The underscore convention for defining members in Typescript allows for clear and concise

Answer №1

Answer №2

Answer №3

Answer №4

Similar questions

The FlatList glides effortlessly in any direction

Exploring jasmine-node: unraveling the mysteries of errors

"Exploring the World of Android WebView with JavaScript

Tips for populating a dictionary with a large datalist of around 2000 items

The React axios request triggers the UseEffect cleanup function to terminate all subscriptions and asynchronous tasks

The settimeout function does not seem to function properly within the context of

How can we ensure that material-ui fields render properly following a reset call in react-hook-form?

Is there a way to eliminate spaces from a string using react-native?

Combining React state value with an HTML tag would be a great way

Invoking a PHP class through an AJAX response handler code

Is there a way to create a customized calendar in Node.js?

Angular 2 Issue: Error Message "Cannot bind to 'ngModel'" arises after FormsModule is added to app.module

Converting an ISO date to a standard JS date: The straightforward approach

Encountering difficulty when trying to define the onComplete function in Conf.ts. A type error is occurring, stating that '(passed: any) => void' is not compatible with type '() => void'.ts(2322)'

When a tooltip inside a button is clicked, the hover effect is passing through to the surrounding parent element

Is there a way to send map data using props in React?

Working with scrollIntoView in useEffect (Encountering an error trying to access 'scrollIntoView' property of null)

Enhance ant design modal functionality by enabling resizing capabilities

Looking to update the background color of a div every 3 seconds?

Setting the content-type for static assets in NuxtJS