Class CallContext

Hierarchy

CallContext

Index

Properties

#arrayBufferType #config #decoder #encoder #hostContext #logLevel #logger #memoryOptions #stack #vars #varsSize

Accessors

Methods

alloc deleteVariable getVariable hostContext length read setError setVariable store

Properties

`Private` #arrayBufferType

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

Type declaration

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

`Private` #config

#config: PluginConfig

`Private` #decoder

#decoder: TextDecoder

`Private` #encoder

#encoder: TextEncoder

`Private` #hostContext

#hostContext: any

`Private` #logLevel

#logLevel: LogLevelPriority

`Private` #logger

#logger: Console

`Private` #memoryOptions

#memoryOptions: MemoryOptions

`Private` #stack

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

`Private` #vars

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

`Private` #varsSize

#varsSize: number

Accessors

logLevel

get logLevel(): LogLevel
Returns LogLevel
- Defined in src/call-context.ts:217
set logLevel(v): void
Parameters
- v: LogLevel
Returns void
- Defined in src/call-context.ts:221

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:102

deleteVariable

deleteVariable(name): void
Delete a variable if present.
Parameters
- name: string
Returns void
- Defined in src/call-context.ts:156

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:128

hostContext

hostContext<T>(): T
Type Parameters
- T = any
Returns T
- Defined in src/call-context.ts:94

length

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

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:171

setError

setError(err?): void
Parameters
- err: null | string | Error = null
Returns void
- Defined in src/call-context.ts:208

setVariable

setVariable(name, value): void
Set a variable to a given string or byte array value.
Parameters
- name: string
- value: string | Uint8Array
Returns void
- Defined in src/call-context.ts:138

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:191

Generated using TypeDoc