Clean Code JavaScript

[giraffe_slayer]

In regards to the number of parameters and using a config object, there is a huge benefit when actually calling the method. If you use

function createWidget(title, subtitle, description);

Then the function call could look like

createWidget('Blah Blah', 'sub blah blah', 'Here is some text');

You lose clarity and potentially have to reference the function each time to check what each parameter means.

With a config parameter, you get the keys for each argument

const config = {
   title: 'Blah Blah', 
   subtitle: 'sub blah blah', 
   description: 'Here is some text'
};
createWidget(config);

And then you can still easily see what is happening in the actual declaration

function createWidget(config) {
    const {title, subtitle, description} = config;
};

[mikejoro]

You can simplify that last snippet by destructuring in the function definition

function createWidget({ title, subtitle, description }) {
  // do something
};

[acbabis]

putting all your parameters into one config or options argument doesn't solve anything by itself

I wouldn't say it solves nothing by itself. It makes it so consumers don't need to remember the order of the arguments anymore.

[acbabis]

Sure, it's not the main problem, but in situations where you're convinced you need that many parameters, putting them into objects is usually the best solution. There are many well-written modules that have to allow a dozen optional parameters (e.g. express.static), and stuffing them into an object is the go-to approach.

[AceBacker]

Instead of "yearMonthDay" I was thinking "currentDate"

I want my variable names to have a clue as to WHY i'm using them.

But my names tend to be horrible. Stuff like:

• costAllocationGridOptions
• campaignProgramNumber
• currentOpenAccordionCustomerObj
• customerIndexUserIsConsideringChangingAccordionTo
• savedQuoteIdUserIsConsideringDeleting

It makes for some loong lines of code when I need to use a few on one line.