dots.vscode.notebook-renderer-messaging — io.github.dots-cljs/dots-vscode 1.89.0-6

Renderer messaging is used to communicate with a single renderer. It's returned from {@link notebooks.createRendererMessaging }.

on-did-receive-message cljs

(on-did-receive-message notebook-renderer-messaging)

(on-did-receive-message notebook-renderer-messaging listener)

(on-did-receive-message notebook-renderer-messaging listener this-args)

(on-did-receive-message notebook-renderer-messaging
                        listener
                        this-args
                        disposables)

An event that fires when a message is received from a renderer.

Parameters:

• listener: (e: T) => any - The listener function will be called when the event happens.
• this-args: any - The this-argument which will be used when calling the event listener.
• disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

post-message cljs

(post-message notebook-renderer-messaging message)

(post-message notebook-renderer-messaging message editor)

Send a message to one or all renderer.

Parameters:

• message: any - Message to send
• editor: NotebookEditor | undefined - Editor to target with the message. If not provided, the message is sent to all renderers.

Returns: Thenable<boolean> - a boolean indicating whether the message was successfully delivered to any renderer.