code style

Author: jtpio

packages/javascript-kernel/src/display.ts

@@ -2,14 +2,14 @@
 // Distributed under the terms of the Modified BSD License.
 
 /**
- * MIME bundle for rich display
+ * MIME bundle for rich display.
  */
 export interface IMimeBundle {
   [key: string]: any;
 }
 
 /**
- * Display request from $$.display()
+ * Display request from $$.display().
  */
 export interface IDisplayData {
   data: IMimeBundle;
@@ -20,59 +20,71 @@ export interface IDisplayData {
 }
 
 /**
- * Callbacks for display operations
+ * Callbacks for display operations.
  */
 export interface IDisplayCallbacks {
   onDisplay?: (data: IDisplayData) => void;
   onClear?: (wait: boolean) => void;
 }
 
 /**
- * Display helper class for rich output
+ * Display helper class for rich output.
  * Provides methods like html(), svg(), png(), etc.
  */
 export class DisplayHelper {
-  private _displayCallback?: (data: IDisplayData) => void;
-  private _clearCallback?: (wait: boolean) => void;
-  private _displayId?: string;
-  private _result?: IMimeBundle;
-
+  /**
+   * Instantiate a new DisplayHelper.
+   *
+   * @param displayId - Optional display ID for update operations.
+   */
   constructor(displayId?: string) {
     this._displayId = displayId;
   }
 
   /**
-   * Set the callbacks for display operations
+   * Set the callbacks for display operations.
+   *
+   * @param callbacks - The callbacks for display and clear operations.
    */
   setCallbacks(callbacks: IDisplayCallbacks): void {
     this._displayCallback = callbacks.onDisplay;
     this._clearCallback = callbacks.onClear;
   }
 
   /**
-   * Get the result if set via display methods
+   * Get the result if set via display methods.
+   *
+   * @returns The MIME bundle result, or undefined if not set.
    */
   getResult(): IMimeBundle | undefined {
     return this._result;
   }
 
   /**
-   * Clear the result
+   * Clear the result.
    */
   clearResult(): void {
     this._result = undefined;
   }
 
   /**
-   * Create a new display with optional ID
-   * Usage: $$.display('my-id').html('<div>...</div>')
+   * Create a new display with optional ID.
+   *
+   * @param id - Optional display ID for update operations.
+   * @returns A new DisplayHelper instance.
+   *
+   * @example
+   * $$.display('my-id').html('<div>...</div>')
    */
   display(id?: string): DisplayHelper {
     return new DisplayHelper(id);
   }
 
   /**
-   * Display HTML content
+   * Display HTML content.
+   *
+   * @param content - The HTML content to display.
+   * @param metadata - Optional metadata for the display.
    */
   html(content: string, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -82,7 +94,10 @@ export class DisplayHelper {
   }
 
   /**
-   * Display SVG content
+   * Display SVG content.
+   *
+   * @param content - The SVG content to display.
+   * @param metadata - Optional metadata for the display.
    */
   svg(content: string, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -95,7 +110,10 @@ export class DisplayHelper {
   }
 
   /**
-   * Display PNG image (base64 encoded)
+   * Display PNG image (base64 encoded).
+   *
+   * @param base64Content - The base64-encoded PNG data.
+   * @param metadata - Optional metadata for the display.
    */
   png(base64Content: string, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -108,7 +126,10 @@ export class DisplayHelper {
   }
 
   /**
-   * Display JPEG image (base64 encoded)
+   * Display JPEG image (base64 encoded).
+   *
+   * @param base64Content - The base64-encoded JPEG data.
+   * @param metadata - Optional metadata for the display.
    */
   jpeg(base64Content: string, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -121,14 +142,20 @@ export class DisplayHelper {
   }
 
   /**
-   * Display plain text
+   * Display plain text.
+   *
+   * @param content - The text content to display.
+   * @param metadata - Optional metadata for the display.
    */
   text(content: string, metadata?: Record<string, any>): void {
     this._sendDisplay({ 'text/plain': content }, metadata);
   }
 
   /**
-   * Display Markdown content
+   * Display Markdown content.
+   *
+   * @param content - The Markdown content to display.
+   * @param metadata - Optional metadata for the display.
    */
   markdown(content: string, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -138,7 +165,10 @@ export class DisplayHelper {
   }
 
   /**
-   * Display LaTeX content
+   * Display LaTeX content.
+   *
+   * @param content - The LaTeX content to display.
+   * @param metadata - Optional metadata for the display.
    */
   latex(content: string, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -148,7 +178,10 @@ export class DisplayHelper {
   }
 
   /**
-   * Display JSON content
+   * Display JSON content.
+   *
+   * @param content - The JSON content to display.
+   * @param metadata - Optional metadata for the display.
    */
   json(content: any, metadata?: Record<string, any>): void {
     this._sendDisplay(
@@ -161,15 +194,20 @@ export class DisplayHelper {
   }
 
   /**
-   * Display with custom MIME bundle
+   * Display with custom MIME bundle.
+   *
+   * @param mimeBundle - The MIME bundle to display.
+   * @param metadata - Optional metadata for the display.
    */
   mime(mimeBundle: IMimeBundle, metadata?: Record<string, any>): void {
     this._sendDisplay(mimeBundle, metadata);
   }
 
   /**
-   * Clear the current output
-   * @param options.wait If true, wait for new output before clearing
+   * Clear the current output.
+   *
+   * @param options - Clear options.
+   * @param options.wait - If true, wait for new output before clearing.
    */
   clear(options: { wait?: boolean } = {}): void {
     if (this._clearCallback) {
@@ -178,7 +216,7 @@ export class DisplayHelper {
   }
 
   /**
-   * Send display data
+   * Send display data.
    */
   private _sendDisplay(
     data: IMimeBundle,
@@ -197,4 +235,9 @@ export class DisplayHelper {
       this._result = data;
     }
   }
+
+  private _displayCallback?: (data: IDisplayData) => void;
+  private _clearCallback?: (wait: boolean) => void;
+  private _displayId?: string;
+  private _result?: IMimeBundle;
 }