Interface Manifest

The manifest which describes the Plugin code and runtime constraints. This is passed to createPlugin

let manifest = {
  wasm: [{name: 'my-wasm', url: 'http://example.com/path/to/wasm'}],
  config: {
    'greeting': 'hello' // these variables will be available via `extism_get_var` in plugins
  }
}

Every member of .wasm is expected to be an instance of ManifestWasm.

See

Extism > Concepts > Manifest

Hierarchy

  • ManifestOptions
    • Manifest

Properties

allowedHosts? allowedPaths? allowed_hosts allowed_paths config? memory? timeoutMs? timeout_ms wasm

Properties

Optional allowedHosts

allowedHosts?: string[]

A list of allowed hostnames. Wildcard subdomains are supported via *.

Requires the plugin to run in a worker using runInWorker: true.

Example

await createPlugin('path/to/some/wasm', {
  runInWorker: true,
  allowedHosts: ['*.example.com', 'www.dylibso.com']
})

Optional allowedPaths

allowedPaths?: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

allowed_hosts

allowed_hosts: undefined | string[]

allowed_paths

allowed_paths: undefined | {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Optional config

config?: PluginConfigLike

Optional memory

memory?: MemoryOptions

Optional timeoutMs

timeoutMs?: null | number

timeout_ms

timeout_ms: undefined | null | number

wasm

wasm: ManifestWasm[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc