jlbun
    Preparing search index...

    Class JuliaFunction

    Wrapper for Julia Function.

    If the JuliaFunction comes from a JS function, the underlying JSCallback will be automatically cleaned up when the function is garbage collected. You can also manually call .close() to release resources earlier.

    Hierarchy

    • Function
      • JuliaFunction

    Implements

    Index

    Constructors

    Properties

    "[metadata]": DecoratorMetadataObject
    arguments: any
    caller: Function
    length: number
    name: string

    Returns the name of the function. Function names are read-only and can not be changed.

    prototype: any
    ptr: Pointer
    rawCB?: JSCallback

    Accessors

    Methods

    • Determines whether the given value inherits from this function if this function was used as a constructor function.

      A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

      Parameters

      • value: any

      Returns boolean

    • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

      Parameters

      • this: Function
      • thisArg: any

        The object to be used as the this object.

      • OptionalargArray: any

        A set of arguments to be passed to the function.

      Returns any

    • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

      Parameters

      • this: Function
      • thisArg: any

        An object to which the this keyword can refer inside the new function.

      • ...argArray: any[]

        A list of arguments to be passed to the new function.

      Returns any

    • Calls a method of an object, substituting another object for the current object.

      Parameters

      • this: Function
      • thisArg: any

        The object to be used as the current object.

      • ...argArray: any[]

        A list of arguments to be passed to the method.

      Returns any

    • Free the underlying JSCallback if this function is created from one. This is optional as callbacks are automatically cleaned up when the JuliaFunction is garbage collected, but can be used to release resources earlier.

      Returns void

    • Create a JuliaFunction from a JS function.

      The underlying JSCallback will be automatically cleaned up when the returned JuliaFunction is garbage collected. You can also manually call .close() to release resources earlier.

      Parameters

      • jsFunc: (...args: any[]) => any

        The JS function to be wrapped.

      • definition: FFIFunction

        Type definition of the JS function. It follows Bun's JSCallback.

      Returns JuliaFunction