aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/dumbymap.mjs
diff options
context:
space:
mode:
authorHsieh Chin Fan <pham@topo.tw>2024-10-10 11:51:57 +0800
committerHsieh Chin Fan <pham@topo.tw>2024-10-10 13:18:41 +0800
commitbfafe34d5c79f30f274c66709775ed8b13a016c5 (patch)
treef7d9ef26c65d13d89cb299c30224649201c6c13a /src/dumbymap.mjs
parent3d9865d91d46fe398bcd668859370fdbed7d90cd (diff)
docs(jsdoc): update jsdoc
Diffstat (limited to 'src/dumbymap.mjs')
-rw-r--r--src/dumbymap.mjs18
1 files changed, 10 insertions, 8 deletions
diff --git a/src/dumbymap.mjs b/src/dumbymap.mjs
index ac8392c..b01c73e 100644
--- a/src/dumbymap.mjs
+++ b/src/dumbymap.mjs
@@ -26,10 +26,11 @@ const defaultLayouts = [
26const mapCache = {} 26const mapCache = {}
27 27
28/** 28/**
29 * markdown2HTML. 29 * Converts Markdown content to HTML and prepares it for DumbyMap rendering
30 * 30 *
31 * @param {HTMLElement} container -- Target Element to include generated HTML contents 31 * @param {HTMLElement} container - Target Element to include generated HTML contents
32 * @param {String} mdContent -- Texts in Markdown 32 * @param {string} mdContent - Texts in Markdown format
33 * @returns {Object} An object representing the DumbyMap instance
33 */ 34 */
34export const markdown2HTML = (container, mdContent) => { 35export const markdown2HTML = (container, mdContent) => {
35 /** Prepare Elements for Container */ 36 /** Prepare Elements for Container */
@@ -106,11 +107,12 @@ export const markdown2HTML = (container, mdContent) => {
106} 107}
107 108
108/** 109/**
109 * generateMaps. 110 * Generates maps based on the provided configuration
110 * 111 *
111 * @param {HTMLElement} container -- Target Element contains HTML contents 112 * @param {HTMLElement} container - The container element for the maps
112 * @param {Number} options.delay -- delay of map generation, milliseconds 113 * @param {Object} options - Configuration options
113 * @return {Object} dumbymap -- Include and Elements and Methods about managing contents 114 * @param {number} [options.delay=1000] - Delay before rendering maps (in milliseconds)
115 * @param {Function} options.mapCallback - Callback function to be called after map rendering
114 */ 116 */
115export const generateMaps = (container, { layouts = [], delay, renderCallback } = {}) => { 117export const generateMaps = (container, { layouts = [], delay, renderCallback } = {}) => {
116 /** Prepare Contaner/HTML Holder/Showcase */ 118 /** Prepare Contaner/HTML Holder/Showcase */
@@ -509,4 +511,4 @@ export const generateMaps = (container, { layouts = [], delay, renderCallback }
509 ) 511 )
510 512
511 return Object.seal(dumbymap) 513 return Object.seal(dumbymap)
512} 514} \ No newline at end of file