Book Image

Refactoring TypeScript

By : James Hickey
Book Image

Refactoring TypeScript

By: James Hickey

Overview of this book

Refactoring improves your code without changing its behavior. With refactoring, the best approach is to apply small targeted changes to a codebase. Instead of doing a huge sweeping change to your code, refactoring is better as a long-term and continuous enterprise. Refactoring TypeScript explains how to spot bugs and remove them from your code. You’ll start by seeing how wordy conditionals, methods, and null checks make code unhealthy and unstable. Whether it is identifying messy nested conditionals or removing unnecessary methods, this book will show various techniques to avoid these pitfalls and write code that is easier to understand, maintain, and test. By the end of the book, you’ll have learned some of the main causes of unhealthy code, tips to identify them and techniques to address them.
Table of Contents (11 chapters)

Creating a Reusable Private Method

The code snippet from the previous chapter is such a common case that we'll use it in this section:

public getUsers(
    includeInactive: boolean = false, 
    filterText: string = null, 
    orderByName: boolean = false, 
    forHireDate: Date = null) : User[] {
}

Ask yourself: Are the parameters just data that I need to give it? Or do some of the parameters indicate that the method is going to alter its behavior?

If you answered yes to the second question, then you probably want to refactor this method.

The easy wins when finding these kinds of methods is to:

  1. Make them private
  2. Create wrapper methods exposing the intended behaviors by their individual names

Step 1 would entail changing getUsers to a private method.

Next, let's look at all the different behaviors this method is exposing:

  • Get active users
  • Get inactive users
  • Get users that have a certain name
  • Get users and order them by...