Merge pull request #4464 from Tyriar/4409

Correct registerMarker docs
This commit is contained in:
Daniel Imms
2023-03-31 12:12:19 -07:00
committed by GitHub
4 changed files with 5 additions and 6 deletions
+1 -1
View File
@@ -917,7 +917,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
return this.buffer.markers; 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); return this.buffer.addMarker(this.buffer.ybase + this.buffer.y + cursorYOffset);
} }
+1 -1
View File
@@ -59,7 +59,7 @@ export interface IPublicTerminal extends IDisposable {
registerLinkProvider(linkProvider: ILinkProvider): IDisposable; registerLinkProvider(linkProvider: ILinkProvider): IDisposable;
registerCharacterJoiner(handler: (text: string) => [number, number][]): number; registerCharacterJoiner(handler: (text: string) => [number, number][]): number;
deregisterCharacterJoiner(joinerId: number): void; deregisterCharacterJoiner(joinerId: number): void;
addMarker(cursorYOffset: number): IMarker | undefined; addMarker(cursorYOffset: number): IMarker;
registerDecoration(decorationOptions: IDecorationOptions): IDecoration | undefined; registerDecoration(decorationOptions: IDecorationOptions): IDecoration | undefined;
hasSelection(): boolean; hasSelection(): boolean;
getSelection(): string; getSelection(): string;
+1 -1
View File
@@ -156,7 +156,7 @@ export class Terminal implements ITerminalApi {
this._checkProposedApi(); this._checkProposedApi();
this._core.deregisterCharacterJoiner(joinerId); this._core.deregisterCharacterJoiner(joinerId);
} }
public registerMarker(cursorYOffset: number = 0): IMarker | undefined { public registerMarker(cursorYOffset: number = 0): IMarker {
this._verifyIntegers(cursorYOffset); this._verifyIntegers(cursorYOffset);
return this._core.addMarker(cursorYOffset); return this._core.addMarker(cursorYOffset);
} }
+2 -3
View File
@@ -954,12 +954,11 @@ declare module 'xterm' {
deregisterCharacterJoiner(joinerId: number): void; deregisterCharacterJoiner(joinerId: number): void;
/** /**
* Adds a marker to the normal buffer and returns it. If the alt buffer is * Adds a marker to the normal buffer and returns it.
* active, undefined is returned.
* @param cursorYOffset The y position offset of the marker from the cursor. * @param cursorYOffset The y position offset of the marker from the cursor.
* @returns The new marker or undefined. * @returns The new marker or undefined.
*/ */
registerMarker(cursorYOffset?: number): IMarker | undefined; registerMarker(cursorYOffset?: number): IMarker;
/** /**
* (EXPERIMENTAL) Adds a decoration to the terminal using * (EXPERIMENTAL) Adds a decoration to the terminal using