Keep the calculation of a magic number
Written byPhuoc Nguyen
Created
11 Mar, 2021
Category
Practice
Tags
JavaScript
Let's say that we want to calculate the number of difference days between two given dates.
By simply using the
`-` operator, it's easy for us to calculate the differences between two date objects, `date` and `otherDate` for example:js
const diff = Math.abs(date - otherDate);The function returns the number of milliseconds. In order to get the number of days, we have to divide it by
`86400000`:js
Math.ceil(diff / 86400000);We know that
`86400000` is the total number of milliseconds in a day. The code is still working fine until there's another people on the team looking at it, and it takes them time to realize what the number `86400000` is.To make the code more readable and easy to maintain, we should replace the magic number with its calculation:
js
// Better version
const diffDays = (date, otherDate) => Math.ceil((Math.abs(date - otherDate) / 1000) * 60 * 60 * 24);If the number is used across different places, for example when we create a library for manipulating dates, then it's recommended to declare the magic number as a constant:
js
// The best version
// constants.js
const MILLISECOND_DAY = 1000 * 60 * 60 * 24;
export { MILLISECOND_DAY };Then reuse it later:
js
import { MILLISECOND_DAY } from './constants';
const diffDays = (date, otherDate) => Math.ceil(Math.abs(date - otherDate) / MILLISECOND_DAY);#See also
Questions? 🙋
Do you have any questions about front-end development? If so, feel free to create a new issue on GitHub using the button below. I'm happy to help with any topic you'd like to learn more about, even beyond what's covered in this post.
While I have a long list of upcoming topics, I'm always eager to prioritize your questions and ideas for future content. Let's learn and grow together! Sharing knowledge is the best way to elevate ourselves 🥷.
Recent posts ⚡
Newsletter 🔔
If you're into front-end technologies and you want to see more of the content I'm creating, then you might want to consider subscribing to my newsletter.
By subscribing, you'll be the first to know about new articles, products, and exclusive promotions.
Don't worry, I won't spam you. And if you ever change your mind, you can unsubscribe at any time.
Phước Nguyễn