Search for a command to run...
I am developer from India currently based in Berlin, Germany.
I am very interested in Design, though I don't design 😉 I take care of it while making my apps.
Photography, videography and having random conversation over beer are my activities of spare time. Timelapses and hyperlapses make me wonder all the time 😊
No comments yet. Be the first to comment.
Today's npm package is memoizerific Many times in our JavaScript functions, we need to do some heavy lifting; like sorting 100s of tuples, formatting strings inside objects etc. And if there operations are similar but executed very often, it is good...
Modern Frontend is similar to good old web development, but with one catch: the page in the browser is as sophisticated as the backend. Since we learned to load things asynchronously, we want to keep the user as productive as possible and not show an...
Current web development is revolving around responsiveness when it comes to supporting multiple form factors. Though the hardware tech is also pacing itself forward we can see a huge variety of handheld devices as they are portable and powerful. Curr...
What if we ACTUALLY deliver our computer? Let's see how Containerization and Docker solve the "works on my computer" problem.
Today's npm package is objectorarray This package can help you quickly checking if the variable is an Object or Array. Of course there are direct and vanilla-js ways to check if any value is an object or array. But having a centralized package to avo...
Today's npm package is postcss-js CSS in JS libraries are on rise and they have their benefits. And with CSS-in-JS libs, making the CSS output future-proof and backward compatible is very important. PostCSS has been a very important tool in the front...
Today's npm package is jsdoc-to-markdown
Documentation is as important as solving the problem. And whats better than jsdocs for JavaScript apps.
The way you can define a simple JSDoc is as follows:
// index.js
/**
* Function to generate the Square of a Number
*
* @param {Number} x - The number to be squared
* @return {Number} Squared value of passed Number
*/
const square = (x) => {
return Math.pow(x, 2);
};
export default square;
And what better than auto generating the Markdown Readme from JSDoc.
Todays package jsdoc-to-markdown will allow you to do so.
All you have to do is to add jsdoc-to-markdown as a dependency and then you can run it via npm scripts
Install as:
npm i -D jsdoc-to-markdown
Add to scripts. in package.json
{
...
"scripts": {
"gen-docs": "jsdoc2md index.js > API.md"
}
}
And then executing the command on CLI as:
npm run gen-docs
will give us following API.md file:
<a name="square"></a>
## square(x) ⇒ <code>Number</code>
Function to generate the Square of a Number
**Kind**: global function
**Returns**: <code>Number</code> - Squared value of passed Number
| Param | Type | Description |
| --- | --- | --- |
| x | <code>Number</code> | The number to be squared |
Stay tuned for tomorrow's package of the Day.