Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.vscode.notebook-renderer-messaging

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

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

on-did-receive-messagecljs

(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.

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.
sourceraw docstring

post-messagecljs

(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.

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.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close