From 6997f1a9406907acc68b4a7349983462a70eb18d Mon Sep 17 00:00:00 2001
From: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
Date: Fri, 31 Mar 2023 11:54:21 -0700
Subject: [PATCH] Correct registerMarker docs

Fixes #4409
---
 src/browser/Terminal.ts        | 2 +-
 src/browser/Types.d.ts         | 2 +-
 src/browser/public/Terminal.ts | 2 +-
 typings/xterm.d.ts             | 5 ++---
 4 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/src/browser/Terminal.ts b/src/browser/Terminal.ts
index 1890de77..fe19f954 100644
--- a/src/browser/Terminal.ts
+++ b/src/browser/Terminal.ts
@@ -917,7 +917,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
     return this.buffer.markers;
   }
 
-  public addMarker(cursorYOffset: number): IMarker | undefined {
+  public addMarker(cursorYOffset: number): IMarker {
     return this.buffer.addMarker(this.buffer.ybase + this.buffer.y + cursorYOffset);
   }
 
diff --git a/src/browser/Types.d.ts b/src/browser/Types.d.ts
index 3da4bfc0..5f2ed899 100644
--- a/src/browser/Types.d.ts
+++ b/src/browser/Types.d.ts
@@ -59,7 +59,7 @@ export interface IPublicTerminal extends IDisposable {
   registerLinkProvider(linkProvider: ILinkProvider): IDisposable;
   registerCharacterJoiner(handler: (text: string) => [number, number][]): number;
   deregisterCharacterJoiner(joinerId: number): void;
-  addMarker(cursorYOffset: number): IMarker | undefined;
+  addMarker(cursorYOffset: number): IMarker;
   registerDecoration(decorationOptions: IDecorationOptions): IDecoration | undefined;
   hasSelection(): boolean;
   getSelection(): string;
diff --git a/src/browser/public/Terminal.ts b/src/browser/public/Terminal.ts
index 6012dd76..3c9b6d3a 100644
--- a/src/browser/public/Terminal.ts
+++ b/src/browser/public/Terminal.ts
@@ -156,7 +156,7 @@ export class Terminal implements ITerminalApi {
     this._checkProposedApi();
     this._core.deregisterCharacterJoiner(joinerId);
   }
-  public registerMarker(cursorYOffset: number = 0): IMarker | undefined {
+  public registerMarker(cursorYOffset: number = 0): IMarker {
     this._verifyIntegers(cursorYOffset);
     return this._core.addMarker(cursorYOffset);
   }
diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index ed329715..68b37153 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -954,12 +954,11 @@ declare module 'xterm' {
     deregisterCharacterJoiner(joinerId: number): void;
 
     /**
-     * Adds a marker to the normal buffer and returns it. If the alt buffer is
-     * active, undefined is returned.
+     * Adds a marker to the normal buffer and returns it.
      * @param cursorYOffset The y position offset of the marker from the cursor.
      * @returns The new marker or undefined.
      */
-    registerMarker(cursorYOffset?: number): IMarker | undefined;
+    registerMarker(cursorYOffset?: number): IMarker;
 
     /**
      * (EXPERIMENTAL) Adds a decoration to the terminal using