Members
(constant) fs
process to read / write files.
(constant) logger
Logging library
(uses pino under the sheets)
(constant) path
library to resolve paths
Methods
removeIJSContext()
Helper for classes that need to mock being within the iJavaScript context
Type Definitions
Console
Properties:
| Name | Type | Description |
|---|---|---|
log |
function | logs a message to the console |
warn |
function | |
error |
function |
Type:
- Object
DateFormat
Properties:
| Name | Type | Description |
|---|---|---|
LOCAL |
String | local datetime |
LOCAL_DATE |
String | local date |
LOCAL_TIME |
String | local time |
GMT |
String | toGMTString() format |
ISO |
String | toISOString() format |
UTC |
String | toUTCString() format |
NONE |
String | toString() format |
Type:
- Object
FieldLabel
Properties:
| Name | Type | Description |
|---|---|---|
newFieldName |
String | value as the Label to be printed for that field |
Type:
- Object
FieldPath
Properties:
| Name | Type | Description |
|---|---|---|
newFieldName |
String | Dot notation path to value |
Type:
- Object
IJavaScriptContext
Properties:
| Name | Type | Description |
|---|---|---|
$$ |
Jupyter$$ | current display |
display |
Jupyter$$ | (alias for $$) - current display |
console |
Console | current console |
Type:
- Object
Jupyter$$
Properties:
| Name | Type | Description |
|---|---|---|
sendResult |
JupyterSendResult | |
display |
JupyterCreateDisplay | |
async |
function | tells jupyter to run asynchronously |
Type:
- Object
JupyterCreateDisplay() → {JupyterDisplay}
Creates a display
Returns:
- Type
- JupyterDisplay
JupyterDisplay
Properties:
| Name | Type | Description |
|---|---|---|
text |
displayStrFn | |
html |
displayStrFn | |
svg |
displayStrFn | |
png |
displayB64Fn | |
jpeg |
displayB64Fn | |
mime |
displayMimeFn | Displays with mime type via ({ mimeType: value }) |
json |
displayJSON | |
close |
function |
Type:
- Object
JupyterSendResult(value) → {void}
Sends the result to a jupyter cell
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any |
Returns:
- Type
- void
LabelValue
Properties:
| Name | Type | Description |
|---|---|---|
label |
String | |
value |
String |
Type:
- Object
StaticMember
Properties:
| Name | Type | Description |
|---|---|---|
isMethod |
Boolean | |
type |
String | the typeof for the member |
constructor |
String | the type of constructor for the class |
name |
String | the name of the member |
Type:
- Object
TableArray
Properties:
| Name | Type | Description |
|---|---|---|
headers |
String | |
data |
Array.<Array.<any>> |
Type:
- Object
displayB64Fn(b64) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
b64 |
String |
Returns:
- Type
- void
displayJSON(value)
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | values to be printed |
displayMimeFn(obj) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object | each property key is the mime type |
Returns:
- Type
- void
displayStrFn(str) → {void}
Description
Parameters:
| Name | Type | Description |
|---|---|---|
str |
String | Description |
Returns:
- string description
- Type
- void
emptyFn() → {void}
Returns:
- Type
- void