Class JuliaFunction

Wrapper for Julia Function.

If the JuliaFunction comes from a JS function, you can use the .rawCB field to get the raw JSCallback and use cb.close() if the function will no longer be used.

Hierarchy

  • Function
    • JuliaFunction

Implements

Constructors

constructor

Properties

arguments caller length name prototype ptr rawCB?

Accessors

value

Methods

[hasInstance] apply bind call callWithKwargs close toString from

Constructors

constructor

Properties

arguments

arguments: any

caller

caller: Function

Readonly length

length: number

name

name: string

prototype

prototype: any

ptr

ptr: number

Optional rawCB

rawCB?: JSCallback

Accessors

value

Methods

[hasInstance]

  • [hasInstance](value: any): boolean

  • 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

apply

  • 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.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • 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.

    • Rest ...argArray: any[]

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

    Returns any

call

  • 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.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

callWithKwargs

close

  • Free the underlying JSCallback if this function is created from one.

    Returns void

toString

Static from

  • Create a JuliaFunction from a JS function.

    Parameters

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

      The JS function to be wrapped.

        • (...args: any[]): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    • definition: FFIFunction

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

    Returns JuliaFunction

Settings

Member Visibility

Theme

Generated using TypeDoc