Packages

boam

0.1.3

0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Boa-powered JavaScript runtimes for Elixir with BEAM dispatch hooks.

HexDocs

Current section

Files

Jump to

Readme 5 Versions 2 Dependencies Dependants Files Activity

boam doc api-reference.md

Raw

doc/api-reference.md

# boam v0.1.3 - API Reference

## Modules

- Getting Started
  - [Boam](Boam.md): High-level entrypoint for running JavaScript through Boa from Elixir.

- Runtime
  - [Boam.Dispatcher](Boam.Dispatcher.md): Dispatch process for `beam.call(...)` requests originating in JavaScript.
  - [Boam.JS](Boam.JS.md): Helpers for generating JavaScript shim code around the `beam.call(...)` bridge.
  - [Boam.Runtime](Boam.Runtime.md): `GenServer` wrapper around a single Boa runtime.

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".