Class PyodideAPI

Hierarchy (View Summary)

APIBase
- PyodideAPI

Index

Constructors

constructor

new PyodideAPI(worker: WorkerCommunication): PyodideAPI
Parameters
- worker: WorkerCommunication
Returns PyodideAPI
Inherited from APIBase.constructor
- Defined in src/scripts/pyodideAPI/workerCommunication.js:328

Properties

worker

worker: WorkerCommunication

Methods

deleteFile

deleteFile(path: any): Promise<WorkerResponse<boolean>>
Parameters
- path: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:39

exists

exists(path: any): Promise<WorkerResponse<boolean>>
Parameters
- path: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:29

forceDrawing

forceDrawing(
    circuitString: any,
    paramMap: any,
    optionsString: any,
): Promise<
    WorkerResponse<
        {
            errMsgs: string;
            isValidSyntax: boolean;
            svgData: string;
            warnMsgs: string;
        },
    >,
>
Parameters
- circuitString: any
- paramMap: any
- optionsString: any
Returns Promise<
    WorkerResponse<
        {
            errMsgs: string;
            isValidSyntax: boolean;
            svgData: string;
            warnMsgs: string;
        },
    >,
>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:97

getDataPromise

getDataPromise<K extends keyof PyodideAPIMap>(
    method: K,
    data?: PyodideAPIMap[K]["input"],
    timeout?: number,
): Promise<WorkerResponse<PyodideAPIMap[K]["output"]>>
Type Parameters
- K extends keyof PyodideAPIMap
Parameters
- method: K
  {K}
- data: PyodideAPIMap[K]["input"] = {}
  {PyodideAPIMap[K]["input"]}
- Optionaltimeout: number = conf.worker.request.timeout
  {number}
Returns Promise<WorkerResponse<PyodideAPIMap[K]["output"]>>
Inherited from APIBase.getDataPromise
- Defined in src/scripts/pyodideAPI/workerCommunication.js:349

importPackage

importPackage(packageName: any): Promise<WorkerResponse<any>>
Convenience wrapper (still typed via runPython)
Parameters
- packageName: any
Returns Promise<WorkerResponse<any>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:62

isValidCircuitFile

isValidCircuitFile(
    filename: any,
    filepath: any,
): Promise<
    WorkerResponse<{ errors: string; isValid: boolean; warnings: string }>,
>
Parameters
- filename: any
- filepath: any
Returns Promise<WorkerResponse<{ errors: string; isValid: boolean; warnings: string }>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:82

isValidCircuitString

isValidCircuitString(
circuitString: any,
): Promise<
WorkerResponse<{ errors: string; isValid: boolean; warnings: string }>,
>
Parameters
- circuitString: any
Returns Promise<WorkerResponse<{ errors: string; isValid: boolean; warnings: string }>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:90

loadSolver

loadSolver(): Promise<WorkerResponse<boolean>>
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:44

mkdir

mkdir(path: any): Promise<WorkerResponse<boolean>>
Parameters
- path: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:77

pyimport

pyimport(moduleName: any): Promise<WorkerResponse<boolean>>
Parameters
- moduleName: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:67

readDir

readDir(path: any): Promise<WorkerResponse<string[]>>
Parameters
- path: any
Returns Promise<WorkerResponse<string[]>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:15

readFile

readFile(path: any, encoding?: string): Promise<WorkerResponse<string>>
Parameters
- path: any
- encoding: string = "utf8"
Returns Promise<WorkerResponse<string>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:49

ready

ready(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:110

recursiveRmdir

recursiveRmdir(path: any): Promise<WorkerResponse<boolean>>
Parameters
- path: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:72

rename

rename(from: any, to: any): Promise<WorkerResponse<boolean>>
Parameters
- from: any
- to: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:34

requestResponse

requestResponse<K extends keyof PyodideAPIMap>(
    request:
        | WorkerRequest<any>
        | { action: K; data: PyodideAPIMap[K]["input"]; id: number },
): Promise<WorkerResponse<PyodideAPIMap[K]["output"]>>
!! Only use WorkerRequest class plain object is only for type hints !!
Type Parameters
- K extends keyof PyodideAPIMap
Parameters
- request: WorkerRequest<any> | { action: K; data: PyodideAPIMap[K]["input"]; id: number }
Returns Promise<WorkerResponse<PyodideAPIMap[K]["output"]>>
Inherited from APIBase.requestResponse
- Defined in src/scripts/pyodideAPI/workerCommunication.js:338

runPython

runPython(code: any): Promise<WorkerResponse<boolean>>
Parameters
- code: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:54

unpackArchive

unpackArchive(
    pkgArrBuff: any,
    packageExtension: any,
    options: any,
): Promise<WorkerResponse<boolean>>
Parameters
- pkgArrBuff: any
- packageExtension: any
- options: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:7

writeFile

writeFile(
    path: any,
    content: any,
    encoding?: string,
): Promise<WorkerResponse<boolean>>
Parameters
- path: any
- content: any
- encoding: string = "utf8"
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:20

zipFiles

zipFiles(path: any): Promise<WorkerResponse<boolean>>
Parameters
- path: any
Returns Promise<WorkerResponse<boolean>>
- Defined in src/scripts/pyodideAPI/pyodideAPI.js:106

Class PyodideAPI

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PyodideAPI

Properties

worker

Methods

deleteFile

Parameters

Returns Promise<WorkerResponse<boolean>>

exists

Parameters

Returns Promise<WorkerResponse<boolean>>

forceDrawing

Parameters

Returns Promise< WorkerResponse< { errMsgs: string; isValidSyntax: boolean; svgData: string; warnMsgs: string; }, >,>

getDataPromise

Type Parameters

Parameters

Returns Promise<WorkerResponse<PyodideAPIMap[K]["output"]>>

importPackage

Parameters

Returns Promise<WorkerResponse<any>>

isValidCircuitFile

Parameters

Returns Promise<WorkerResponse<{ errors: string; isValid: boolean; warnings: string }>>

isValidCircuitString

Parameters

Returns Promise<WorkerResponse<{ errors: string; isValid: boolean; warnings: string }>>

loadSolver

Returns Promise<WorkerResponse<boolean>>

mkdir

Parameters

Returns Promise<WorkerResponse<boolean>>

pyimport

Parameters

Returns Promise<WorkerResponse<boolean>>

readDir

Parameters

Returns Promise<WorkerResponse<string[]>>

readFile

Parameters

Returns Promise<WorkerResponse<string>>

ready

Returns Promise<boolean>

recursiveRmdir

Parameters

Returns Promise<WorkerResponse<boolean>>

rename

Parameters

Returns Promise<WorkerResponse<boolean>>

requestResponse

Type Parameters

Parameters

Returns Promise<WorkerResponse<PyodideAPIMap[K]["output"]>>

runPython

Parameters

Returns Promise<WorkerResponse<boolean>>

unpackArchive

Parameters

Returns Promise<WorkerResponse<boolean>>

writeFile

Parameters

Returns Promise<WorkerResponse<boolean>>

zipFiles

Parameters

Returns Promise<WorkerResponse<boolean>>

Settings

On This Page

Returns Promise<
WorkerResponse<
{
errMsgs: string;
isValidSyntax: boolean;
svgData: string;
warnMsgs: string;
},
>,
>