html-to-markdown-wasm 2.9.1 → 2.10.1

package/dist-node/package.json

@@ -3,7 +3,7 @@
   "collaborators": [
     "Na'aman Hirschfeld <nhirschfeld@gmail.com>"
   ],
-  "version": "2.9.1",
+  "version": "2.10.1",
   "license": "MIT",
   "repository": {
     "type": "git",

package/dist-web/README.md

@@ -51,19 +51,19 @@ Experience WebAssembly-powered HTML to Markdown conversion instantly in your bro
 
 ## Installation
 
-| Target                      | Command                                                                   |
-| --------------------------- | ------------------------------------------------------------------------- |
-| **Node.js/Bun** (native)    | `npm install html-to-markdown-node`                                       |
-| **WebAssembly** (universal) | `npm install html-to-markdown-wasm`                                       |
-| **Deno**                    | `import { convert } from "npm:html-to-markdown-wasm"`                     |
-| **Python** (bindings + CLI) | `pip install html-to-markdown`                                            |
-| **PHP** (extension + helpers) | `pie install goldziher/html-to-markdown`<br>`composer require html-to-markdown/extension` |
-| **Ruby** gem                | `bundle add html-to-markdown` or `gem install html-to-markdown`           |
-| **Elixir** (Rustler NIF)    | `{:html_to_markdown, "~> 2.8"}`                                           |
-| **Rust** crate              | `cargo add html-to-markdown-rs`                                           |
-| Rust CLI                    | `cargo install html-to-markdown-cli`                                      |
-| Homebrew CLI                | `brew tap goldziher/tap`<br>`brew install html-to-markdown`               |
-| Releases                    | [GitHub Releases](https://github.com/Goldziher/html-to-markdown/releases) |
+| Target                      | Command(s)                                                                                                       |
+| --------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| **Node.js/Bun** (native)    | `npm install html-to-markdown-node`                                                                              |
+| **WebAssembly** (universal) | `npm install html-to-markdown-wasm`                                                                              |
+| **Deno**                    | `import { convert } from "npm:html-to-markdown-wasm"`                                                            |
+| **Python** (bindings + CLI) | `pip install html-to-markdown`                                                                                   |
+| **PHP** (extension + helpers) | `PHP_EXTENSION_DIR=$(php-config --extension-dir) pie install goldziher/html-to-markdown`<br>`composer require goldziher/html-to-markdown` |
+| **Ruby** gem                | `bundle add html-to-markdown` or `gem install html-to-markdown`                                                  |
+| **Elixir** (Rustler NIF)    | `{:html_to_markdown, "~> 2.8"}`                                                                                  |
+| **Rust** crate              | `cargo add html-to-markdown-rs`                                                                                  |
+| Rust CLI (crates.io)        | `cargo install html-to-markdown-cli`                                                                             |
+| Homebrew CLI                | `brew install html-to-markdown` (core)                                                                          |
+| Releases                    | [GitHub Releases](https://github.com/Goldziher/html-to-markdown/releases)                                        |
 
 ## Quick Start
 

package/dist-web/html_to_markdown_wasm.d.ts

@@ -1,42 +1,12 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * Convert HTML to Markdown
- *
- * # Arguments
- *
- * * `html` - The HTML string to convert
- * * `options` - Optional conversion options (as a JavaScript object)
- *
- * # Example
- *
- * ```javascript
- * import { convert } from 'html-to-markdown-wasm';
- *
- * const html = '<h1>Hello World</h1>';
- * const markdown = convert(html);
- * console.log(markdown); // # Hello World
- * ```
- */
-export function convert(html: string, options: any): string;
-export function convertWithInlineImages(html: string, options: any, image_config?: WasmInlineImageConfig | null): WasmHtmlExtraction;
-export function convertBytesWithOptionsHandle(html: Uint8Array, handle: WasmConversionOptionsHandle): string;
-export function convertBytesWithInlineImages(html: Uint8Array, options: any, image_config?: WasmInlineImageConfig | null): WasmHtmlExtraction;
-export function createConversionOptionsHandle(options: any): WasmConversionOptionsHandle;
-export function convertWithOptionsHandle(html: string, handle: WasmConversionOptionsHandle): string;
-export function convertBytes(html: Uint8Array, options: any): string;
-/**
- * Initialize panic hook for better error messages in the browser
- */
-export function init(): void;
+
 export class WasmConversionOptionsHandle {
   free(): void;
   [Symbol.dispose](): void;
   constructor(options: any);
 }
-/**
- * Result of HTML extraction with inline images
- */
+
 export class WasmHtmlExtraction {
   private constructor();
   free(): void;
@@ -45,9 +15,7 @@ export class WasmHtmlExtraction {
   readonly markdown: string;
   readonly warnings: WasmInlineImageWarning[];
 }
-/**
- * Inline image data
- */
+
 export class WasmInlineImage {
   private constructor();
   free(): void;
@@ -60,9 +28,7 @@ export class WasmInlineImage {
   readonly source: string;
   readonly filename: string | undefined;
 }
-/**
- * Inline image configuration
- */
+
 export class WasmInlineImageConfig {
   free(): void;
   [Symbol.dispose](): void;
@@ -71,9 +37,7 @@ export class WasmInlineImageConfig {
   set filenamePrefix(value: string | null | undefined);
   set inferDimensions(value: boolean);
 }
-/**
- * Warning about inline image processing
- */
+
 export class WasmInlineImageWarning {
   private constructor();
   free(): void;
@@ -82,6 +46,43 @@ export class WasmInlineImageWarning {
   readonly message: string;
 }
 
+/**
+ * Convert HTML to Markdown
+ *
+ * # Arguments
+ *
+ * * `html` - The HTML string to convert
+ * * `options` - Optional conversion options (as a JavaScript object)
+ *
+ * # Example
+ *
+ * ```javascript
+ * import { convert } from 'html-to-markdown-wasm';
+ *
+ * const html = '<h1>Hello World</h1>';
+ * const markdown = convert(html);
+ * console.log(markdown); // # Hello World
+ * ```
+ */
+export function convert(html: string, options: any): string;
+
+export function convertBytes(html: Uint8Array, options: any): string;
+
+export function convertBytesWithInlineImages(html: Uint8Array, options: any, image_config?: WasmInlineImageConfig | null): WasmHtmlExtraction;
+
+export function convertBytesWithOptionsHandle(html: Uint8Array, handle: WasmConversionOptionsHandle): string;
+
+export function convertWithInlineImages(html: string, options: any, image_config?: WasmInlineImageConfig | null): WasmHtmlExtraction;
+
+export function convertWithOptionsHandle(html: string, handle: WasmConversionOptionsHandle): string;
+
+export function createConversionOptionsHandle(options: any): WasmConversionOptionsHandle;
+
+/**
+ * Initialize panic hook for better error messages in the browser
+ */
+export function init(): void;
+
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
@@ -125,6 +126,7 @@ export interface InitOutput {
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
+
 /**
 * Instantiates the given `module`, which can either be bytes or
 * a precompiled `WebAssembly.Module`.