Class Library

constructor

• new Library(path: string): Library

  Parameters

  • path: string

  Returns Library

Readonlypath

Readonlyloaded

func

• func<TRet extends FFIType, const TArgs extends readonly FFIType[]>(
      name: string,
      returnType: TRet,
      argTypes: TArgs,
      options?: FunctionOptions,
  ): NativeFFIFunction<TArgs, TRet>

  Typed overload: narrows args/return when argTypes is a literal tuple.

  Type Parameters

  • TRet extends FFIType
  • const TArgs extends readonly FFIType[]

  Parameters

  • name: string
  • returnType: TRet
  • argTypes: TArgs
  • Optionaloptions: FunctionOptions

  Returns NativeFFIFunction<TArgs, TRet>

• func(
      name: string,
      returnType: FFIType,
      argTypes?: FFIType[],
      options?: FunctionOptions,
  ): NativeFFIFunction

  Typed overload: narrows args/return when argTypes is a literal tuple.

  Parameters

  • name: string
  • returnType: FFIType
  • OptionalargTypes: FFIType[]
  • Optionaloptions: FunctionOptions

  Returns NativeFFIFunction

callback

• callback(returnType: AnyType, argTypes: AnyType[], fn: Function): Callback

  Create a native callback. Note the argument order (return type, argument types, function), which differs from callback and CDLL.callback.

  Parameters

  • returnType: AnyType
  • argTypes: AnyType[]
  • fn: Function

  Returns Callback

symbol

• symbol(name: string): bigint

  Get the address of a symbol in the library.

  Parameters

  • name: string

    Symbol name

  Returns bigint

  Address as BigInt

close

• close(): void

  Logically close the library. Functions obtained from it throw when called afterwards. Throws while a call to one of its functions is in progress (from a callback, or a pending callAsync()). Existing in_dll() views and dependent memory remain valid and defer native handle release until their last owner is collected. Physical unloading depends on the OS loader; musl keeps modules resident.

  Returns void