Skip to content

01-API.md

Latest commit

 

History

History
107 lines (60 loc) · 2.27 KB

01-API.md

File metadata and controls

107 lines (60 loc) · 2.27 KB
Raw
title API Documentation
section AngleSharp.Wasm

API Documentation

This page summarizes the currently available public API surface.

Configuration Extensions

Extension methods are available on IConfiguration via AngleSharp.Wasm:

WithWasm()

Registers the default Wasmtime-backed runtime factory.

var config = Configuration.Default.WithWasm();

WithWasm(Func<IBrowsingContext, IWasmRuntimeFactory>)

Registers a custom runtime factory creator.

WithWasmImports(IWasmImportProvider)

Registers a host import provider.

WithWasmImports(Func<IBrowsingContext, IEnumerable<WasmImportFunction>>)

Registers host imports via delegate.

DOM-Facing API (AngleSharp.Wasm.Dom)

When used with a scripting integration that discovers DOM attributes, the following surface is exposed under WebAssembly.

WebAssembly.compile(byte[] moduleBytes)

Compiles bytes and returns a WasmJsModule.

WebAssembly.instantiate(WasmJsModule module)

Instantiates a compiled module and returns a WasmJsInstance.

WasmJsModule

exports()

Returns WasmModuleExportDescriptor[] with:

  • name
  • kind (function, table, memory, global, tag)

imports()

Returns WasmModuleImportDescriptor[] with:

  • module
  • name
  • kind

customSections(string sectionName)

Returns all matching custom section payloads as byte[][].

WasmJsInstance

exports (getter)

Returns a WasmJsExports object.

invoke(string exportName, params object?[] arguments)

Invokes an exported function by name.

WasmJsExports

this[string name]

Returns an export entry by name:

  • WasmJsExportedFunction for function exports
  • WasmJsExportValue for non-function exports
  • null if no export is found

keys()

Returns all export names.

WasmJsExportedFunction

invoke(params object?[] arguments)

Invokes the wrapped exported function.

WasmJsExportValue

Descriptor type for non-function exports.

  • name
  • kind

Notes on Scope

This API is intentionally focused on a practical subset of the full WebAssembly JS API spec. See Questions for limitations and expected behavior.

For a section-by-section status overview, see Spec Coverage Matrix.