Skip to content

Latest commit

 

History

History
151 lines (87 loc) · 4.01 KB

modules.md

File metadata and controls

151 lines (87 loc) · 4.01 KB
Raw

Documentation / Exports

Documentation

Table of contents

Interfaces

Type Aliases

Functions

Type Aliases

PyClearMethod

Ƭ PyClearMethod: (namespace: string) => Promise<{ error: any ; results: any }>

Type for the clear method of the PyRunner interface.

Type declaration

▸ (namespace): Promise<{ error: any ; results: any }>

Parameters
Name Type Description
namespace string The namespace to clear.
Returns

Promise<{ error: any ; results: any }>

Defined in

interfaces.ts:172

PyLoadMethod

Ƭ PyLoadMethod: (pyoPackages?: string[], packages?: string[], initCode?: string, transformCode?: string) => Promise<{ error: any ; results: any }>

Type for the load method of the PyRunner interface.

Type declaration

▸ (pyoPackages?, packages?, initCode?, transformCode?): Promise<{ error: any ; results: any }>

Parameters
Name Type Description
pyoPackages? string[] Optional array of Python packages to load.
packages? string[] Optional array of additional packages to load.
initCode? string Optional initialization code to run.
transformCode? string Optional transformation code to run.
Returns

Promise<{ error: any ; results: any }>

Defined in

interfaces.ts:127

PyRunAsyncMethod

Ƭ PyRunAsyncMethod: (script: string, namespace?: string, id?: string, context?: Record<string, any>) => Promise<{ error: any ; results: any }>

Type for the runAsync method of the PyRunner interface.

Type declaration

▸ (script, namespace?, id?, context?): Promise<{ error: any ; results: any }>

Parameters
Name Type Description
script string The Python script to run.
namespace? string Optional namespace for the script.
id? string Optional identifier for the script execution.
context? Record<string, any> Optional context for the script execution.
Returns

Promise<{ error: any ; results: any }>

Defined in

interfaces.ts:159

PyRunMethod

Ƭ PyRunMethod: (script: string, namespace?: string, id?: string, context?: Record<string, any>) => Promise<{ error: any ; results: any }>

Type for the run method of the PyRunner interface.

Type declaration

▸ (script, namespace?, id?, context?): Promise<{ error: any ; results: any }>

Parameters
Name Type Description
script string The Python script to run.
namespace? string Optional namespace for the script.
id? string Optional identifier for the script execution.
context? Record<string, any> Optional context for the script execution.
Returns

Promise<{ error: any ; results: any }>

Defined in

interfaces.ts:143

Functions

usePython

▸ usePython(): PyRunner

The main composable

Returns

PyRunner

Defined in

py.ts:6