Class CallContext

Hierarchy

CallContext

Index

Properties

#arrayBufferType #blocks #config #decoder #encoder #logger #stack #vars

Methods

alloc getVariable length read setVariable store

Properties

`Private` #arrayBufferType

#arrayBufferType: (new (size) => ArrayBufferLike)

Type declaration

- new (size): ArrayBufferLike
- Parameters
  - size: number
  Returns ArrayBufferLike

`Private` #blocks

#blocks: (null | Block)[] = []

`Private` #config

#config: PluginConfig

`Private` #decoder

#decoder: TextDecoder

`Private` #encoder

#encoder: TextEncoder

`Private` #logger

#logger: Console

`Private` #stack

#stack: [null | number, null | number, null | number][]

`Private` #vars

#vars: Map<string, number> = ...

Methods

alloc

alloc(size): bigint
Allocate a chunk of host memory visible to plugins via other extism host functions. Returns the start address of the block.
Parameters
- size: number | bigint
Returns bigint
- Defined in src/call-context.ts:75

getVariable

getVariable(name): null | PluginOutput
Read a variable from extism memory by name.
Parameters
- name: string
Returns null | PluginOutput
PluginOutput
- Defined in src/call-context.ts:87

length

length(addr): bigint
Parameters
- addr: bigint
Returns bigint
- Defined in src/call-context.ts:155

read

read(addr): null | PluginOutput
Given an address in extism memory, return a PluginOutput that represents a view of that memory. Returns null if the address is invalid.
Parameters
- addr: number | bigint
Returns null | PluginOutput
bigint
- Defined in src/call-context.ts:127

setVariable

setVariable(name, value): bigint
Set a variable to a given string or byte array value. Returns the start address of the variable. The start address is reused when changing the value of an existing variable.
Parameters
- name: string
- value: string | Uint8Array
Returns bigint
bigint
- Defined in src/call-context.ts:101

store

store(input): bigint
Store a string or Uint8Array value in extism memory.
Parameters
- input: string | Uint8Array
Returns bigint
bigint
- Defined in src/call-context.ts:147

Generated using TypeDoc