Deno.ForeignFunction - Deno documentation

interface Deno.ForeignFunction

The interface for a foreign function as defined by its parameter and result types.

Type Parameters

Parameters extends readonly NativeType[] = readonly NativeType[]

Result extends NativeResultType = NativeResultType

NonBlocking extends boolean = boolean

optional

name: string

Name of the symbol.

Defaults to the key name in symbols object.

parameters: Parameters

The parameters of the foreign function.

result: Result

The result (return value) of the foreign function.

optional

nonblocking: NonBlocking

When true, function calls will run on a dedicated blocking thread and will return a Promise resolving to the result.

optional

optional: boolean = false

When true, dlopen will not fail if the symbol is not found. Instead, the symbol will be set to null.