Skip to content

Commit fb4447e

Browse files
committed
docs: update jsdoc
1 parent d3539bb commit fb4447e

2 files changed

Lines changed: 30 additions & 30 deletions

File tree

index.cjs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
/**
2-
* @author Victor Giovanni Beltrán Rodríguez
3-
* @file Manages main entry point.
4-
*/
5-
6-
// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
7-
/**
8-
* The `argv2Object()` function, converts command-line arguments to a key-value
9-
* object.
2+
* @file Entry point for CommonJS consumers.
103
*
11-
* This function takes an array of command-line arguments and converts them to a
12-
* JavaScript object with keys and values based on the provided argument format.
13-
* The format can be either simple key-value pairs (e.g. "key=value") or
14-
* Unix-style command-line options (e.g. "-o --option=value").
4+
* Provides compatibility layer for Node.js environments
5+
* using CommonJS require() system.
156
*
16-
* @version 1.0.0
17-
* @author Victor Giovanni Beltrán Rodríguez
18-
* @module argv2Object
7+
* This wrapper adapts the ESM default export to CommonJS
8+
* module.exports pattern.
9+
*
10+
* @module argv2object/cjs
11+
* @see module:argv2Object
12+
* @since 1.1.0
13+
* @example
14+
* // CJS Usage
15+
* const argv2object = require('argv2object');
1916
*/
17+
18+
// ━━ IMPORT MODULES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
19+
// » IMPORT LOCAL MODULES
2020
const argv2Object = require('#argv2Object');
2121

2222
// ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

index.mjs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
/**
2-
* @author Victor Giovanni Beltrán Rodríguez
3-
* @file Manages main entry point.
4-
*/
5-
6-
// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
7-
/**
8-
* The `argv2Object()` function, converts command-line arguments to a key-value
9-
* object.
2+
* @file Entry point for ES Module consumers.
103
*
11-
* This function takes an array of command-line arguments and converts them to a
12-
* JavaScript object with keys and values based on the provided argument format.
13-
* The format can be either simple key-value pairs (e.g. "key=value") or
14-
* Unix-style command-line options (e.g. "-o --option=value").
4+
* Provides the default export of argv2object functionality
5+
* for modern JavaScript environments using ES Modules.
156
*
16-
* @version 1.0.0
17-
* @author Victor Giovanni Beltrán Rodríguez
18-
* @module argv2Object
7+
* This file re-exports the main functionality from the
8+
* implementation module while maintaining ESM compatibility.
9+
*
10+
* @module argv2object/esm
11+
* @see module:argv2Object
12+
* @since 1.1.0
13+
* @example
14+
* // ESM Usage
15+
* import argv2object from 'argv2object';
1916
*/
17+
18+
// ━━ IMPORT MODULES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
19+
// » IMPORT LOCAL MODULES
2020
import argv2Object from '#argv2Object';
2121

2222
// ━━ EXPORT MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

0 commit comments

Comments
 (0)