Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
xterm - npm Package Compare versions
Comparing version 5.3.0-beta.33 to 5.3.0-beta.34
| { | ||
| "name": "xterm", | ||
| "description": "Full xterm terminal, in your browser", | ||
| "version": "5.3.0-beta.33", | ||
| "version": "5.3.0-beta.34", | ||
| "main": "lib/xterm.js", | ||
@@ -33,2 +33,3 @@ "style": "css/xterm.css", | ||
| "lint": "eslint -c .eslintrc.json --max-warnings 0 --ext .ts src/ addons/", | ||
| "lint-api": "eslint --no-eslintrc -c .eslintrc.json.typings --max-warnings 0 --no-ignore --ext .d.ts typings/", | ||
| "test": "npm run test-unit", | ||
@@ -35,0 +36,0 @@ "posttest": "npm run lint", |
@@ -29,3 +29,4 @@ /** | ||
| * Whether to allow the use of proposed API. When false, any usage of APIs | ||
| * marked as experimental/proposed will throw an error. The default is false. | ||
| * marked as experimental/proposed will throw an error. The default is | ||
| * false. | ||
| */ | ||
@@ -79,6 +80,7 @@ allowProposedApi?: boolean; | ||
| /** | ||
| * Whether to draw custom glyphs for block element and box drawing characters instead of using | ||
| * the font. This should typically result in better rendering with continuous lines, even when | ||
| * line height and letter spacing is used. Note that this doesn't work with the DOM renderer | ||
| * which renders all characters using the font. The default is true. | ||
| * Whether to draw custom glyphs for block element and box drawing | ||
| * characters instead of using the font. This should typically result in | ||
| * better rendering with continuous lines, even when line height and letter | ||
| * spacing is used. Note that this doesn't work with the DOM renderer which | ||
| * renders all characters using the font. The default is true. | ||
| */ | ||
@@ -285,5 +287,5 @@ customGlyphs?: boolean; | ||
| /** | ||
| * A string containing all characters that are considered word separated by the | ||
| * double click to select work logic. | ||
| */ | ||
| * A string containing all characters that are considered word separated by | ||
| * the double click to select work logic. | ||
| */ | ||
| wordSeparator?: string; | ||
@@ -336,3 +338,6 @@ | ||
| selectionForeground?: string; | ||
| /** The selection background color when the terminal does not have focus (can be transparent) */ | ||
| /** | ||
| * The selection background color when the terminal does not have focus (can | ||
| * be transparent) | ||
| */ | ||
| selectionInactiveBackground?: string; | ||
@@ -394,19 +399,19 @@ /** ANSI black (eg. `\x1b[30m`) */ | ||
| /** | ||
| * Log a debug message, this will only be called if {@link ITerminalOptions.logLevel} is set to | ||
| * debug. | ||
| * Log a debug message, this will only be called if | ||
| * {@link ITerminalOptions.logLevel} is set to debug. | ||
| */ | ||
| debug(message: string, ...args: any[]): void; | ||
| /** | ||
| * Log a debug message, this will only be called if {@link ITerminalOptions.logLevel} is set to | ||
| * info or below. | ||
| * Log a debug message, this will only be called if | ||
| * {@link ITerminalOptions.logLevel} is set to info or below. | ||
| */ | ||
| info(message: string, ...args: any[]): void; | ||
| /** | ||
| * Log a debug message, this will only be called if {@link ITerminalOptions.logLevel} is set to | ||
| * warn or below. | ||
| * Log a debug message, this will only be called if | ||
| * {@link ITerminalOptions.logLevel} is set to warn or below. | ||
| */ | ||
| warn(message: string, ...args: any[]): void; | ||
| /** | ||
| * Log a debug message, this will only be called if {@link ITerminalOptions.logLevel} is set to | ||
| * error or below. | ||
| * Log a debug message, this will only be called if | ||
| * {@link ITerminalOptions.logLevel} is set to error or below. | ||
| */ | ||
@@ -451,4 +456,2 @@ error(message: string | Error, ...args: any[]): void; | ||
| * Represents a disposable that tracks is disposed state. | ||
| * @param onDispose event listener and | ||
| * @param isDisposed property. | ||
| */ | ||
@@ -468,3 +471,4 @@ export interface IDisposableWithEvent extends IDisposable { | ||
| /** | ||
| * Represents a decoration in the terminal that is associated with a particular marker and DOM element. | ||
| * Represents a decoration in the terminal that is associated with a | ||
| * particular marker and DOM element. | ||
| */ | ||
@@ -492,5 +496,5 @@ export interface IDecoration extends IDisposableWithEvent { | ||
| /** | ||
| * The options for the overview ruler that can be updated. | ||
| * This will only take effect when {@link IDecorationOptions.overviewRulerOptions} | ||
| * were provided initially. | ||
| * The options for the overview ruler that can be updated. This will only | ||
| * take effect when {@link IDecorationOptions.overviewRulerOptions} were | ||
| * provided initially. | ||
| */ | ||
@@ -542,4 +546,5 @@ options: Pick<IDecorationOptions, 'overviewRulerOptions'>; | ||
| /** | ||
| * The background color of the cell(s). When 2 decorations both set the foreground color the | ||
| * last registered decoration will be used. Only the `#RRGGBB` format is supported. | ||
| * The background color of the cell(s). When 2 decorations both set the | ||
| * foreground color the last registered decoration will be used. Only the | ||
| * `#RRGGBB` format is supported. | ||
| */ | ||
@@ -549,4 +554,5 @@ readonly backgroundColor?: string; | ||
| /** | ||
| * The foreground color of the cell(s). When 2 decorations both set the foreground color the | ||
| * last registered decoration will be used. Only the `#RRGGBB` format is supported. | ||
| * The foreground color of the cell(s). When 2 decorations both set the | ||
| * foreground color the last registered decoration will be used. Only the | ||
| * `#RRGGBB` format is supported. | ||
| */ | ||
@@ -557,7 +563,7 @@ readonly foregroundColor?: string; | ||
| * What layer to render the decoration at when {@link backgroundColor} or | ||
| * {@link foregroundColor} are used. `'bottom'` will render under the selection, `'top`' will | ||
| * render above the selection\*. | ||
| * {@link foregroundColor} are used. `'bottom'` will render under the | ||
| * selection, `'top`' will render above the selection\*. | ||
| * | ||
| * *\* The selection will render on top regardless of layer on the canvas renderer due to how | ||
| * it renders selection separately.* | ||
| * *\* The selection will render on top regardless of layer on the canvas | ||
| * renderer due to how it renders selection separately.* | ||
| */ | ||
@@ -573,3 +579,3 @@ readonly layer?: 'bottom' | 'top'; | ||
| */ | ||
| overviewRulerOptions?: IDecorationOverviewRulerOptions | ||
| overviewRulerOptions?: IDecorationOverviewRulerOptions; | ||
| } | ||
@@ -594,3 +600,4 @@ | ||
| /** | ||
| * Enable various window manipulation and report features (CSI Ps ; Ps ; Ps t). | ||
| * Enable various window manipulation and report features | ||
| * (`CSI Ps ; Ps ; Ps t`). | ||
| * | ||
@@ -615,6 +622,6 @@ * Most settings have no default implementation, as they heavily rely on | ||
| * Most features are meant to deal with some information of the host machine | ||
| * where the terminal runs on. This is seen as a security risk possibly leaking | ||
| * sensitive data of the host to the program in the terminal. Therefore all options | ||
| * (even those without a default implementation) are guarded by the boolean flag | ||
| * and disabled by default. | ||
| * where the terminal runs on. This is seen as a security risk possibly | ||
| * leaking sensitive data of the host to the program in the terminal. | ||
| * Therefore all options (even those without a default implementation) are | ||
| * guarded by the boolean flag and disabled by default. | ||
| */ | ||
@@ -887,5 +894,5 @@ export interface IWindowOptions { | ||
| /** | ||
| * Adds an event listener for when a key is pressed. The event value contains the | ||
| * string that will be sent in the data event as well as the DOM event that | ||
| * triggered it. | ||
| * Adds an event listener for when a key is pressed. The event value | ||
| * contains the string that will be sent in the data event as well as the | ||
| * DOM event that triggered it. | ||
| * @returns an `IDisposable` to stop listening. | ||
@@ -1058,6 +1065,7 @@ */ | ||
| * (EXPERIMENTAL) Adds a decoration to the terminal using | ||
| * @param decorationOptions, which takes a marker and an optional anchor, | ||
| * width, height, and x offset from the anchor. Returns the decoration or | ||
| * undefined if the alt buffer is active or the marker has already been disposed of. | ||
| * @throws when options include a negative x offset. | ||
| * @param decorationOptions, which takes a marker and an optional anchor, | ||
| * width, height, and x offset from the anchor. Returns the decoration or | ||
| * undefined if the alt buffer is active or the marker has already been | ||
| * disposed of. | ||
| * @throws when options include a negative x offset. | ||
| */ | ||
@@ -1168,3 +1176,4 @@ registerDecoration(decorationOptions: IDecorationOptions): IDecoration | undefined; | ||
| /** | ||
| * Writes text to the terminal, performing the necessary transformations for pasted text. | ||
| * Writes text to the terminal, performing the necessary transformations for | ||
| * pasted text. | ||
| * @param data The text to write to the terminal. | ||
@@ -1183,6 +1192,6 @@ */ | ||
| /** | ||
| * Clears the texture atlas of the canvas renderer if it's active. Doing this will force a | ||
| * redraw of all glyphs which can workaround issues causing the texture to become corrupt, for | ||
| * example Chromium/Nvidia has an issue where the texture gets messed up when resuming the OS | ||
| * from sleep. | ||
| * Clears the texture atlas of the canvas renderer if it's active. Doing | ||
| * this will force a redraw of all glyphs which can workaround issues | ||
| * causing the texture to become corrupt, for example Chromium/Nvidia has an | ||
| * issue where the texture gets messed up when resuming the OS from sleep. | ||
| */ | ||
@@ -1258,28 +1267,30 @@ clearTextureAtlas(): void; | ||
| */ | ||
| activate(event: MouseEvent, text: string, range: IBufferRange): void; | ||
| activate(event: MouseEvent, text: string, range: IBufferRange): void; | ||
| /** | ||
| * Called when the mouse hovers the link. To use this to create a DOM-based hover tooltip, | ||
| * create the hover element within `Terminal.element` and add the `xterm-hover` class to it, | ||
| * that will cause mouse events to not fall through and activate other links. | ||
| * @param event The mouse event triggering the callback. | ||
| * @param text The text of the link. | ||
| * @param range The buffer range of the link. | ||
| */ | ||
| hover?(event: MouseEvent, text: string, range: IBufferRange): void; | ||
| /** | ||
| * Called when the mouse hovers the link. To use this to create a DOM-based | ||
| * hover tooltip, create the hover element within `Terminal.element` and | ||
| * add the `xterm-hover` class to it, that will cause mouse events to not | ||
| * fall through and activate other links. | ||
| * @param event The mouse event triggering the callback. | ||
| * @param text The text of the link. | ||
| * @param range The buffer range of the link. | ||
| */ | ||
| hover?(event: MouseEvent, text: string, range: IBufferRange): void; | ||
| /** | ||
| * Called when the mouse leaves the link. | ||
| * @param event The mouse event triggering the callback. | ||
| * @param text The text of the link. | ||
| * @param range The buffer range of the link. | ||
| */ | ||
| leave?(event: MouseEvent, text: string, range: IBufferRange): void; | ||
| /** | ||
| * Called when the mouse leaves the link. | ||
| * @param event The mouse event triggering the callback. | ||
| * @param text The text of the link. | ||
| * @param range The buffer range of the link. | ||
| */ | ||
| leave?(event: MouseEvent, text: string, range: IBufferRange): void; | ||
| /** | ||
| * Whether to receive non-HTTP URLs from LinkProvider. When false, any usage of non-HTTP URLs | ||
| * will be ignored. Enabling this option without proper protection in `activate` function | ||
| * may cause security issues such as XSS. | ||
| */ | ||
| allowNonHttpProtocols?: boolean; | ||
| /** | ||
| * Whether to receive non-HTTP URLs from LinkProvider. When false, any | ||
| * usage of non-HTTP URLs will be ignored. Enabling this option without | ||
| * proper protection in `activate` function may cause security issues such | ||
| * as XSS. | ||
| */ | ||
| allowNonHttpProtocols?: boolean; | ||
| } | ||
@@ -1316,5 +1327,5 @@ | ||
| /** | ||
| * What link decorations to show when hovering the link, this property is tracked and changes | ||
| * made after the link is provided will trigger changes. If not set, all decroations will be | ||
| * enabled. | ||
| * What link decorations to show when hovering the link, this property is | ||
| * tracked and changes made after the link is provided will trigger changes. | ||
| * If not set, all decroations will be enabled. | ||
| */ | ||
@@ -1331,5 +1342,6 @@ decorations?: ILinkDecorations; | ||
| /** | ||
| * Called when the mouse hovers the link. To use this to create a DOM-based hover tooltip, | ||
| * create the hover element within `Terminal.element` and add the `xterm-hover` class to it, | ||
| * that will cause mouse events to not fall through and activate other links. | ||
| * Called when the mouse hovers the link. To use this to create a DOM-based | ||
| * hover tooltip, create the hover element within `Terminal.element` and add | ||
| * the `xterm-hover` class to it, that will cause mouse events to not fall | ||
| * through and activate other links. | ||
| * @param event The mouse event triggering the callback. | ||
@@ -1458,3 +1470,4 @@ * @param text The text of the link. | ||
| /** | ||
| * Provides a document fragment or HTMLElement containing the buffer elements. | ||
| * Provides a document fragment or HTMLElement containing the buffer | ||
| * elements. | ||
| */ | ||
@@ -1706,9 +1719,9 @@ provideBufferElements(): DocumentFragment | HTMLElement; | ||
| * Adds a handler for CSI escape sequences. | ||
| * @param id Specifies the function identifier under which the callback | ||
| * gets registered, e.g. {final: 'm'} for SGR. | ||
| * @param id Specifies the function identifier under which the callback gets | ||
| * registered, e.g. {final: 'm'} for SGR. | ||
| * @param callback The function to handle the sequence. The callback is | ||
| * called with the numerical params. If the sequence has subparams the | ||
| * array will contain subarrays with their numercial values. | ||
| * Return `true` if the sequence was handled, `false` if the parser should try | ||
| * a previous handler. The most recently added handler is tried first. | ||
| * called with the numerical params. If the sequence has subparams the array | ||
| * will contain subarrays with their numercial values. Return `true` if the | ||
| * sequence was handled, `false` if the parser should try a previous | ||
| * handler. The most recently added handler is tried first. | ||
| * @returns An IDisposable you can call to remove this handler. | ||
@@ -1720,14 +1733,14 @@ */ | ||
| * Adds a handler for DCS escape sequences. | ||
| * @param id Specifies the function identifier under which the callback | ||
| * gets registered, e.g. {intermediates: '$' final: 'q'} for DECRQSS. | ||
| * @param id Specifies the function identifier under which the callback gets | ||
| * registered, e.g. {intermediates: '$' final: 'q'} for DECRQSS. | ||
| * @param callback The function to handle the sequence. Note that the | ||
| * function will only be called once if the sequence finished sucessfully. | ||
| * There is currently no way to intercept smaller data chunks, data chunks | ||
| * will be stored up until the sequence is finished. Since DCS sequences | ||
| * are not limited by the amount of data this might impose a problem for | ||
| * big payloads. Currently xterm.js limits DCS payload to 10 MB | ||
| * which should give enough room for most use cases. | ||
| * The function gets the payload and numerical parameters as arguments. | ||
| * Return `true` if the sequence was handled, `false` if the parser should try | ||
| * a previous handler. The most recently added handler is tried first. | ||
| * will be stored up until the sequence is finished. Since DCS sequences are | ||
| * not limited by the amount of data this might impose a problem for big | ||
| * payloads. Currently xterm.js limits DCS payload to 10 MB which should | ||
| * give enough room for most use cases. The function gets the payload and | ||
| * numerical parameters as arguments. Return `true` if the sequence was | ||
| * handled, `false` if the parser should try a previous handler. The most | ||
| * recently added handler is tried first. | ||
| * @returns An IDisposable you can call to remove this handler. | ||
@@ -1739,8 +1752,8 @@ */ | ||
| * Adds a handler for ESC escape sequences. | ||
| * @param id Specifies the function identifier under which the callback | ||
| * gets registered, e.g. {intermediates: '%' final: 'G'} for | ||
| * default charset selection. | ||
| * @param id Specifies the function identifier under which the callback gets | ||
| * registered, e.g. {intermediates: '%' final: 'G'} for default charset | ||
| * selection. | ||
| * @param callback The function to handle the sequence. | ||
| * Return `true` if the sequence was handled, `false` if the parser should try | ||
| * a previous handler. The most recently added handler is tried first. | ||
| * Return `true` if the sequence was handled, `false` if the parser should | ||
| * try a previous handler. The most recently added handler is tried first. | ||
| * @returns An IDisposable you can call to remove this handler. | ||
@@ -1756,9 +1769,9 @@ */ | ||
| * There is currently no way to intercept smaller data chunks, data chunks | ||
| * will be stored up until the sequence is finished. Since OSC sequences | ||
| * are not limited by the amount of data this might impose a problem for | ||
| * big payloads. Currently xterm.js limits OSC payload to 10 MB | ||
| * which should give enough room for most use cases. | ||
| * The callback is called with OSC data string. | ||
| * Return `true` if the sequence was handled, `false` if the parser should try | ||
| * a previous handler. The most recently added handler is tried first. | ||
| * will be stored up until the sequence is finished. Since OSC sequences are | ||
| * not limited by the amount of data this might impose a problem for big | ||
| * payloads. Currently xterm.js limits OSC payload to 10 MB which should | ||
| * give enough room for most use cases. The callback is called with OSC data | ||
| * string. Return `true` if the sequence was handled, `false` if the parser | ||
| * should try a previous handler. The most recently added handler is tried | ||
| * first. | ||
| * @returns An IDisposable you can call to remove this handler. | ||
@@ -1849,4 +1862,4 @@ */ | ||
| */ | ||
| readonly wraparoundMode: boolean | ||
| readonly wraparoundMode: boolean; | ||
| } | ||
| } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.01%
2341736
- Lines of code
- increased by0.05%
24489
No dependency changes