Interface RendererMessaging

interface RendererMessaging {
receiveMessage?: ((rendererId, message) => Promise<boolean>);
postMessage(rendererId, message): void;
}

Hierarchy

Disposable
- RendererMessaging

Index

Properties

receiveMessage?

Methods

Properties

`Optional` receiveMessage

receiveMessage?: ((rendererId, message) => Promise<boolean>)

Method called when a message is received. Should return a boolean indicating whether a renderer received it.

Type declaration

- (rendererId, message): Promise<boolean>
- Parameters
  - rendererId: string
  - message: unknown
  Returns Promise<boolean>

Methods

postMessage

postMessage(rendererId, message): void
Sends a message to an extension from a renderer.
Parameters
- rendererId: string
- message: unknown
Returns void
- Defined in packages/notebook/src/browser/service/notebook-renderer-messaging-service.ts:42