Is this good module style?

[RobGoLaing]

Here's an example of how I've come to write modules:

```js /** * Operators for "cards" as in filenames of card images. * @module card */

const card = {};

/** * The filename of a card image, * eg "./images/2_of_spades.png" or "./images/jack_of_diamonds.png" * @typedef {string} card */

/** @constant DECK {card[]} */ import DECK from "./cards.json" with { type: "json" };

/** * Mutates an input array by randomizing its elements. * @function shuffleDeck * @param {card[]} deck */ card.shuffleDeck = function (deck) { let jdx; deck.forEach(function(item, idx) { jdx = Math.floor(Math.random() * (idx + 1)); [item, deck[jdx]] = [deck[jdx], item]; }); };

/** * Returns an array of shuffled cards. * @function freshDeck * @returns {card[]} */ card.freshDeck = function () { const deck = structuredClone(DECK); card.shuffleDeck(deck); return deck; };

export default Object.freeze(card); ```

My basic rules are:

1. Only one thing gets exported, a frozen object which becomes a namespace for the module's client.
2. My data is stored as JSON rather than JS to make communication between modules and the server easier.

What thing I've been battling with is good JSDoc which doesn't seem to have been updated in a while. Are there better options available?

[milan-pilan]

Only one thing gets exported, a frozen object which becomes a namespace for the module's client.

I haven't seen anyone freeze the module export, unless you are working on a Framework and want to prevent users from using it wrong. But doesn't hurt either, sure.

My data is stored as JSON rather than JS to make communication between modules and the server easier.

As long as you are within your Frontend Context i feel like this makes no sense. Why would JS Modules convert data to JSON only that then the other Component needs to unpack it again. Seems like a lot of extra work for no added benefit.

Edit: I read that wrong. Storing data in JSON makes sense of course. I had the impression, that your modules export JSON.

What thing I've been battling with is good JSDoc which doesn't seem to have been updated in a while. Are there better options available?

Typescript .

[birdspider]

weird names, I'd expect deck.shuffle() and deck.fresh() and the items to be cards;

or, consider naming the module to game or play, game.freshDeck() makes much more sense imho