@ox-content/wasm 2.67.0 → 2.68.0

package/ox_content_wasm.d.ts

@@ -2,33 +2,84 @@
 /* eslint-disable */
 
 /**
- * Parser options.
+ * Parser and renderer options exposed to JavaScript.
+ *
+ * `new WasmParserOptions()` disables optional Markdown extensions by default
+ * and uses renderer defaults for TOC and auto-link handling.
  */
 export class WasmParserOptions {
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Creates options with all Markdown extension flags disabled.
+     *
+     * Defaults: `gfm = false`, `tocMaxDepth = 3`, `autolinkUrls = false`,
+     * `autolinkPatterns = ["http://", "https://"]`, and
+     * `autolinkTargetBlank = true`.
+     */
     constructor();
     /**
      * Replaces the URL prefix patterns used by auto-linking. Pass a JS
      * array of strings such as `["http://", "https://", "ftp://"]`.
+     *
+     * Default: `["http://", "https://"]`.
      */
     set autolinkPatterns(value: string[]);
     /**
      * Toggles `target="_blank" rel="noopener noreferrer"` on auto-linked
      * URLs. Has no effect when `autolinkUrls` is off.
+     *
+     * Default: `true`.
      */
     set autolinkTargetBlank(value: boolean);
     /**
      * Enables the renderer's URL auto-linking builtin. Bare URLs matching
      * any registered pattern are wrapped in an `<a>` tag.
+     *
+     * Default: `false`.
      */
     set autolinkUrls(value: boolean);
+    /**
+     * Enables GFM autolinks in the parser.
+     *
+     * Default: `false`.
+     */
     set autolinks(value: boolean);
+    /**
+     * Enables footnote references and definitions.
+     *
+     * Default: `false`.
+     */
     set footnotes(value: boolean);
+    /**
+     * Enables the GFM convenience profile.
+     *
+     * Default: `false`.
+     */
     set gfm(value: boolean);
+    /**
+     * Enables GFM strikethrough spans.
+     *
+     * Default: `false`.
+     */
     set strikethrough(value: boolean);
+    /**
+     * Enables GFM pipe tables.
+     *
+     * Default: `false`.
+     */
     set tables(value: boolean);
+    /**
+     * Enables GFM task-list item markers such as `- [x]`.
+     *
+     * Default: `false`.
+     */
     set taskLists(value: boolean);
+    /**
+     * Sets the maximum heading depth included in inline TOCs.
+     *
+     * Default: `3`.
+     */
     set tocMaxDepth(value: number);
 }
 

package/ox_content_wasm.js

@@ -1,7 +1,10 @@
 /* @ts-self-types="./ox_content_wasm.d.ts" */
 
 /**
- * Parser options.
+ * Parser and renderer options exposed to JavaScript.
+ *
+ * `new WasmParserOptions()` disables optional Markdown extensions by default
+ * and uses renderer defaults for TOC and auto-link handling.
  */
 export class WasmParserOptions {
     __destroy_into_raw() {
@@ -14,6 +17,13 @@ export class WasmParserOptions {
         const ptr = this.__destroy_into_raw();
         wasm.__wbg_wasmparseroptions_free(ptr, 0);
     }
+    /**
+     * Creates options with all Markdown extension flags disabled.
+     *
+     * Defaults: `gfm = false`, `tocMaxDepth = 3`, `autolinkUrls = false`,
+     * `autolinkPatterns = ["http://", "https://"]`, and
+     * `autolinkTargetBlank = true`.
+     */
     constructor() {
         const ret = wasm.wasmparseroptions_new();
         this.__wbg_ptr = ret;
@@ -23,6 +33,8 @@ export class WasmParserOptions {
     /**
      * Replaces the URL prefix patterns used by auto-linking. Pass a JS
      * array of strings such as `["http://", "https://", "ftp://"]`.
+     *
+     * Default: `["http://", "https://"]`.
      * @param {string[]} value
      */
     set autolinkPatterns(value) {
@@ -33,6 +45,8 @@ export class WasmParserOptions {
     /**
      * Toggles `target="_blank" rel="noopener noreferrer"` on auto-linked
      * URLs. Has no effect when `autolinkUrls` is off.
+     *
+     * Default: `true`.
      * @param {boolean} value
      */
     set autolinkTargetBlank(value) {
@@ -41,48 +55,71 @@ export class WasmParserOptions {
     /**
      * Enables the renderer's URL auto-linking builtin. Bare URLs matching
      * any registered pattern are wrapped in an `<a>` tag.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set autolinkUrls(value) {
         wasm.wasmparseroptions_set_autolink_urls(this.__wbg_ptr, value);
     }
     /**
+     * Enables GFM autolinks in the parser.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set autolinks(value) {
         wasm.wasmparseroptions_set_autolinks(this.__wbg_ptr, value);
     }
     /**
+     * Enables footnote references and definitions.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set footnotes(value) {
         wasm.wasmparseroptions_set_footnotes(this.__wbg_ptr, value);
     }
     /**
+     * Enables the GFM convenience profile.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set gfm(value) {
         wasm.wasmparseroptions_set_gfm(this.__wbg_ptr, value);
     }
     /**
+     * Enables GFM strikethrough spans.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set strikethrough(value) {
         wasm.wasmparseroptions_set_strikethrough(this.__wbg_ptr, value);
     }
     /**
+     * Enables GFM pipe tables.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set tables(value) {
         wasm.wasmparseroptions_set_tables(this.__wbg_ptr, value);
     }
     /**
+     * Enables GFM task-list item markers such as `- [x]`.
+     *
+     * Default: `false`.
      * @param {boolean} value
      */
     set taskLists(value) {
         wasm.wasmparseroptions_set_task_lists(this.__wbg_ptr, value);
     }
     /**
+     * Sets the maximum heading depth included in inline TOCs.
+     *
+     * Default: `3`.
      * @param {number} value
      */
     set tocMaxDepth(value) {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ox-content/wasm",
   "type": "module",
   "description": "WebAssembly bindings for Ox Content - Browser-ready Markdown parser",
-  "version": "2.67.0",
+  "version": "2.68.0",
   "license": "MIT",
   "repository": {
     "type": "git",