Class Julia

Hierarchy

Julia

Constructors

constructor

new Julia(): Julia
Returns Julia

Properties

`Static` Any

Any: JuliaDataType

`Static` Base

Base: JuliaModule

`Static` Bool

Bool: JuliaDataType

`Static` Char

Char: JuliaDataType

`Static` Core

Core: JuliaModule

`Static` Float16

Float16: JuliaDataType

`Static` Float32

Float32: JuliaDataType

`Static` Float64

Float64: JuliaDataType

`Static` Function

Function: JuliaDataType

`Static` Int16

Int16: JuliaDataType

`Static` Int32

Int32: JuliaDataType

`Static` Int64

Int64: JuliaDataType

`Static` Int8

Int8: JuliaDataType

`Static` Main

Main: JuliaModule

`Static` Nothing

Nothing: JuliaDataType

`Static` Pkg

Pkg: JuliaModule

`Static` String

String: JuliaDataType

`Static` Symbol

Symbol: JuliaDataType

`Static` UInt16

UInt16: JuliaDataType

`Static` UInt32

UInt32: JuliaDataType

`Static` UInt64

UInt64: JuliaDataType

`Static` UInt8

UInt8: JuliaDataType

`Static` `Private` globals

globals: JuliaIdDict

`Static` nthreads

nthreads: number

`Static` `Private` options

options: JuliaOptions = DEFAULT_JULIA_OPTIONS

Methods

`Static` autoWrap

autoWrap(value: any): JuliaValue
Wrap a JS value as a JuliaValue object.
Parameters
- value: any
  
  Value to be wrapped.
Returns JuliaValue
- Defined in jlbun/julia.ts:275

`Static` call

call(func: JuliaFunction, ...args: any[]): JuliaValue
Call a Julia function with variable arguments.
Parameters
- func: JuliaFunction
  
  The Julia function to be called.
- Rest ...args: any[]
  
  The arguments to be passed to the function. Non-JuliaValue objects will be automatically wrapped by Julia.autoWrap. Since the automatic wrapping does not work perfectly all the time, be sure to wrap the objects yourself in order to feed the function with the exact types.
Returns JuliaValue
- Defined in jlbun/julia.ts:502

`Static` callWithKwargs

callWithKwargs(func: JuliaFunction, kwargs: JuliaNamedTuple | Record<string, any>, ...args: any[]): JuliaValue
Call a Julia function with keyword arguments and variable arguments.
Parameters
- func: JuliaFunction
  
  The Julia function to be called.
- kwargs: JuliaNamedTuple | Record<string, any>
  
  Keyword arguments to be passed to the function. If a plain object is provided, it will be automatically wrapped as a JuliaNamedTuple. Be sure to wrap it yourself to get exact typing.
- Rest ...args: any[]
  
  Variable arguments to be passed to the function. Non-JuliaValue objects will be automatically wrapped by. Be sure to wrap it yourself to get exact typing.
Returns JuliaValue
- Defined in jlbun/julia.ts:538

`Static` close

close(status?: number): void
Close the Julia runtime and also close the dynamic library.
Parameters
- status: number = 0
  
  Status code to be reported.
Returns void
- Defined in jlbun/julia.ts:710

`Static` deleteGlobal

deleteGlobal(name: string): boolean
Delete an object from the global scope maintained by jlbun.

Returns
Whether the object was deleted.
Parameters
- name: string
  
  Name of the object to be deleted.
Returns boolean
- Defined in jlbun/julia.ts:252

`Static` eval

eval(code: string): JuliaValue
Evaluate a Julia code fragment and get the result as a JuliaValue.
Parameters
- code: string
  
  Julia code to be evaluated.
Returns JuliaValue
- Defined in jlbun/julia.ts:579

`Static` getFunction

getFunction(module: JuliaModule, name: string): JuliaFunction
Fetch a Julia function from the given module.
Parameters
- module: JuliaModule
  
  Module to be fetched from.
- name: string
  
  Name of the function to be fetched.
Returns JuliaFunction
- Defined in jlbun/julia.ts:327

`Static` getGlobal

getGlobal(name: string): JuliaValue
Retrieve an object from the global scope maintained by jlbun.
Parameters
- name: string
  
  Name of the object to be retrieved.
Returns JuliaValue
- Defined in jlbun/julia.ts:242

`Static` `Private` getModuleExports

getModuleExports(obj: JuliaValue): string[]
Parameters
- obj: JuliaValue
Returns string[]
- Defined in jlbun/julia.ts:220

`Static` getTypeStr

getTypeStr(ptr: number | JuliaValue): string
Get the string representation of a Julia value's type.
Parameters
- ptr: number | JuliaValue
  
  Pointer to a Julia object, or a JuliaValue object.
Returns string
- Defined in jlbun/julia.ts:261

`Static` handleCallException

handleCallException(func: JuliaFunction, args: any[], kwargs?: JuliaNamedTuple | Record<string, any>): void
Parameters
- func: JuliaFunction
- args: any[]
- kwargs: JuliaNamedTuple | Record<string, any> = {}
Returns void
- Defined in jlbun/julia.ts:459

`Static` `Private` handleEvalException

handleEvalException(code: string): void
Parameters
- code: string
Returns void
- Defined in jlbun/julia.ts:445

`Static` import

import(name: string): JuliaModule
Import a module and get a JuliaModule object referring to that module.
Parameters
- name: string
  
  Name of the module to be imported.
Returns JuliaModule
- Defined in jlbun/julia.ts:619

`Static` include

include(file: string, target?: JuliaModule, mapFn?: JuliaFunction): JuliaValue
Shortcut for Julia.Base.include.
Parameters
- file: string
  
  Relative path of the file to be included.
- target: JuliaModule = Julia.Main
  
  Module to include the file. Default to Main.
- Optional mapFn: JuliaFunction
  
  Mapping function that will be applied to each Expr in the included file.
Returns JuliaValue
- Defined in jlbun/julia.ts:633

`Static` includeString

includeString(code: string, target?: JuliaModule, mapFn?: JuliaFunction): JuliaValue
Shortcut for Julia.Base.include_string.
Parameters
- code: string
  
  Code string to be included.
- target: JuliaModule = Julia.Main
  
  Module to include the file. Default to Main.
- Optional mapFn: JuliaFunction
  
  Mapping function that will be applied to each Expr in the included code string.
Returns JuliaValue
- Defined in jlbun/julia.ts:652

`Static` init

init(extraOptions?: Partial<JuliaOptions>): void
Initialize the Julia runtime. All other methods need to be called after this.
Parameters
- extraOptions: Partial<JuliaOptions> = {}
  
  Extra options for initialization.
Returns void
- Defined in jlbun/julia.ts:100

`Static` `Private` prefetch

prefetch(module: JuliaModule): void
Parameters
- module: JuliaModule
Returns void
- Defined in jlbun/julia.ts:84

`Static` print

print(value: JuliaValue): void
Shortcut for Julia.Base.print().
Parameters
- value: JuliaValue
  
  Object to be printed.
Returns void
- Defined in jlbun/julia.ts:692

`Static` println

println(value: JuliaValue): void
Shortcut for Julia.Base.println().
Parameters
- value: JuliaValue
  
  Object to be printed.
Returns void
- Defined in jlbun/julia.ts:701

`Static` repr

repr(value: JuliaValue, mime?: MIME): string
Get a string representation of a JuliaValue using Julia's repr() function, with the given MIME.
Parameters
- value: JuliaValue
  
  Object to be represented.
- mime: MIME = MIME.Default
  
  The MIME to use. Default to MIME.Default.
Returns string
- Defined in jlbun/julia.ts:670

`Static` setGlobal

setGlobal(name: string, obj: JuliaValue): void
Sava an object to the global scope maintained by jlbun.
Parameters
- name: string
  
  Name to use.
- obj: JuliaValue
  
  Object to be saved.
Returns void
- Defined in jlbun/julia.ts:233

`Static` string

string(value: JuliaValue): string
Stringify a JuliaValue using Julia's string() function,
Parameters
- value: JuliaValue
  
  Object to be stringified.
Returns string
- Defined in jlbun/julia.ts:683

`Static` tagEval

tagEval(strings: TemplateStringsArray, ...values: any[]): JuliaValue
Evaluate a Julia code fragment and get the result as a JuliaValue. This method supports value-interpolation, meaning that the tagged values will be automatically wrapped and interpolated into the code.
Parameters
- strings: TemplateStringsArray
  
  Strings separated by tagged values
- Rest ...values: any[]
  
  Tagged values to be interpolated
Returns JuliaValue
- Defined in jlbun/julia.ts:594

`Static` wrapFunctionCall

wrapFunctionCall(func: JuliaFunction, kwargs: JuliaNamedTuple | Record<string, any>, ...args: any[]): JuliaFunction
Wrap a function with several arguments so that it can be run in a JuliaTask.
Parameters
- func: JuliaFunction
  
  Function to be wrapped.
- kwargs: JuliaNamedTuple | Record<string, any>
  
  Keyword arguments.
- Rest ...args: any[]
  
  Variable arguments.
Returns JuliaFunction
- Defined in jlbun/julia.ts:421

`Static` wrapPtr

wrapPtr(ptr: number): JuliaValue
Wrap a pointer as a JuliaValue object.
Parameters
- ptr: number
  
  Pointer to the Julia object.
Returns JuliaValue
- Defined in jlbun/julia.ts:340

Generated using TypeDoc