Documentation generated by typedoc on Wed Feb 19 2025 15:14:11 GMT+0000 (Coordinated Universal Time) with typedoc-plugin-markdown (and then rendered by quarto).
Interfaces
TControlsOptions
Defined in: live/banner.js:9
Properties
overlayInputs
overlayInputs: TOverlay;Defined in: live/banner.js:10
TOverlay to put api request inputs into.
overlayRenders
overlayRenders: TOverlay;Defined in: live/banner.js:12
Overlay to show all renders so far.
overlayResponses
overlayResponses: TOverlay;Defined in: live/banner.js:11
Overlay to display api responses in.
TForm
Defined in: live/input.js:28
Properties
elem
elem: HTMLDivElement;Defined in: live/input.js:29
form
form: HTMLDivElement;Defined in: live/input.js:30
inputs
inputs: TInput[];Defined in: live/input.js:32
Inputs to be put into the form.
onInvalid()
onInvalid: () => void;Defined in: live/input.js:36
Returns
void
onRequestOver()
onRequestOver: () => void;Defined in: live/input.js:34
Button is no longer disabled, hide spinner, hide overlay, revert error color.
Returns
void
onRequestSent()
onRequestSent: () => void;Defined in: live/input.js:35
Disable button and make spinner visible.
Returns
void
TInput
Defined in: live/input.js:10
Properties
elem
elem: HTMLElement;Defined in: live/input.js:11
errorMsg
errorMsg: HTMLElement;Defined in: live/input.js:13
input
input: HTMLInputElement | HTMLSelectElement;Defined in: live/input.js:12
onInvalid()
onInvalid: () => void;Defined in: live/input.js:15
Returns
void
onValid()
onValid: () => void;Defined in: live/input.js:16
Returns
void
text?
optional text: HTMLElement;Defined in: live/input.js:14
TQuarto
Defined in: live/quarto.js:49
Properties
container
container: HTMLElement;Defined in: live/quarto.js:56
A div containing the renders container.
handleMessage()
handleMessage: (event) => void;Defined in: live/quarto.js:53
Parameters
event
MessageEvent
Returns
void
initialize()
initialize: () => void;Defined in: live/quarto.js:51
Returns
void
overlayRenders
overlayRenders: TOverlay;Defined in: live/quarto.js:54
Output from Overlay for overlay to contain render datas.
state
state: object;Defined in: live/quarto.js:52
table
table: HTMLTableElement;Defined in: live/quarto.js:55
The table containing quarto logs.
ws
ws: WebSocket;Defined in: live/quarto.js:50
TQuartoLogItem
Defined in: live/quarto.js:26
Properties
elem
elem: HTMLTableRowElement;Defined in: live/quarto.js:27
The overlayContentItem
info
info: HTMLElement;Defined in: live/quarto.js:29
render
render: HTMLElement;Defined in: live/quarto.js:28
renderAction()
renderAction: () => void;Defined in: live/quarto.js:30
Returns
void
show()
show: () => void;Defined in: live/quarto.js:31
Show the overlay for this particular item.
Returns
void
TQuartoOptions
Defined in: live/quarto.js:39
Properties
container
container: HTMLElement;Defined in: live/quarto.js:43
A div containing the renders container.
filters?
optional filters: null | object;Defined in: live/quarto.js:40
Filters for websocket messages.
last?
optional last: null | number;Defined in: live/quarto.js:41
Number of initial logs to recieve.
overlayRenders
overlayRenders: TOverlay;Defined in: live/quarto.js:44
Output from Overlay for overlay to contain render datas.
reload?
optional reload: null | boolean;Defined in: live/quarto.js:46
Do page hot reloads.
table
table: HTMLTableElement;Defined in: live/quarto.js:42
The table containing quarto logs.
TQuartoOverlayItem
Defined in: live/quarto.js:21
Properties
elem
elem: HTMLElement;Defined in: live/quarto.js:23
The overlayContentItem
show()
show: () => void;Defined in: live/quarto.js:22
Show the overlay for this particular item.
Returns
void
TQuartoRender
Defined in: live/quarto.js:7
Properties
command
command: string[];Defined in: live/quarto.js:16
Command executed during the render.
item_from
item_from: "client" | "lifespan";Defined in: live/quarto.js:11
Source of the render request.
kind
kind: "defered" | "direct" | "static";Defined in: live/quarto.js:12
Kind of render (default: “direct”).
origin
origin: string;Defined in: live/quarto.js:13
Origin of the render request.
status_code
status_code: number;Defined in: live/quarto.js:15
Status code of the render operation.
stderr
stderr: string[];Defined in: live/quarto.js:17
Standard error output from the render.
stdout
stdout: string[];Defined in: live/quarto.js:18
Standard output from the render.
target
target: string;Defined in: live/quarto.js:14
Target of the render operation.
target_url_path
target_url_path: string;Defined in: live/quarto.js:9
URL to the render target.
time
time: string;Defined in: live/quarto.js:8
Time at which the log was generated.
timestamp
timestamp: number;Defined in: live/quarto.js:10
Timestamp (must be greater than 0).
TServer
Defined in: live/server.js:41
Properties
container
container: HTMLElement;Defined in: live/server.js:44
A parent element of the table. This makes it such that when new logs are pushed the bottom of the page is scrolled to. In the initial version, this was the tab content div.
handleWsMessage()
handleWsMessage: (event) => void;Defined in: live/server.js:45
Handle an event emited by the websocket. Should push new logs to table tbody.
Parameters
event
MessageEvent
Returns
void
table
table: HTMLTableElement;Defined in: live/server.js:43
The table containing all of the server logs.
ws
ws: WebSocket;Defined in: live/server.js:42
TServerOptions
Defined in: live/server.js:34
Properties
container
container: HTMLElement;Defined in: live/server.js:36
A parent element of the table. This makes it such that when new logs are pushed the bottom of the page is scrolled to. In the initial version, this was the tab content div.
table
table: HTMLTableElement;Defined in: live/server.js:35
The table containing all of the server logs.
Type Aliases
References
TQuartoRender
Re-exports TQuartoRender