function

ffi.dlopen

function dlopen<Fns extends Record<string, FFIFunction>>(

name: string | BunFile | URL,

symbols: Fns

): Library<Fns>;

Open a native library and load symbols from it

@param name

Library name or file path, passed to dlopen()

@param symbols

Map of symbols to load where the key is the symbol name and the value is the FFIFunction

import {dlopen} from 'bun:ffi';

const lib = dlopen("duckdb.dylib", {
  get_version: {
    returns: "cstring",
    args: [],
  },
});
lib.symbols.get_version();
// "1.0.0"

Referenced types

class URL

The URL interface represents an object providing static methods used for creating object URLs.

MDN Reference

hash: string
MDN Reference
host: string
MDN Reference
hostname: string
MDN Reference
href: string
MDN Reference
readonly origin: string
MDN Reference
password: string
MDN Reference
pathname: string
MDN Reference
port: string
MDN Reference
protocol: string
MDN Reference
search: string
MDN Reference
readonly searchParams: URLSearchParams
MDN Reference
username: string
MDN Reference
toJSON(): string;
MDN Reference
toString(): string;
static canParse(
url: string | URL,
base?: string | URL
): boolean;
MDN Reference
static createObjectURL(
obj: Blob | MediaSource
): string;
MDN Reference
static parse(
url: string | URL,
base?: string | URL
): null | URL;
MDN Reference
static revokeObjectURL(
url: string
): void;
MDN Reference

interface Library<Fns extends Symbols>

symbols: ConvertFns<Fns>
close(): void;
dlclose the library, unloading the symbols and freeing allocated memory.
Once called, the library is no longer usable.
Calling a symbol from a closed cc library throws a TypeError. Calling a symbol from a closed dlopen or linkSymbols library is undefined behavior.