suneditor 3.0.0-beta.9 → 3.0.0-rc.2

package/types/helper/dom/domUtils.d.ts

@@ -1,3 +1,4 @@
+import type {} from '../../typedef';
 /**
  * @template {Node} T
  * @description Clones a node while preserving its type.
@@ -9,19 +10,27 @@ export function clone<T extends Node>(node: T, deep?: boolean): T;
 /**
  * @template {HTMLElement} T
  * @description Create Element node
+ * @example
+ * // Create with attributes
+ * const span = dom.utils.createElement('SPAN', { style: 'color:red;', class: 'highlight' });
+ *
+ * // Create with HTML string content
+ * const div = dom.utils.createElement('DIV', null, '<p>Hello</p>');
+ *
+ * // Create with a child node
+ * const br = dom.utils.createElement('BR');
+ * const p = dom.utils.createElement('P', null, br);
  * @param {string} elementName Element name
- * @param {?Object<string, string>=} attributes The attributes of the tag. {style: 'font-size:12px;..', class: 'el_class',..}
- * @param {?string|Node=} inner A innerHTML string or inner node.
+ * @param {?Object<string, string>} [attributes] The attributes of the tag. {style: 'font-size:12px;..', class: 'el_class',..}
+ * @param {?string|Node} [inner] A innerHTML string or inner node.
  * @returns {T}
  */
 export function createElement<T extends HTMLElement>(
 	elementName: string,
-	attributes?:
-		| ({
-				[x: string]: string;
-		  } | null)
-		| undefined,
-	inner?: ((string | Node) | null) | undefined
+	attributes?: {
+		[x: string]: string;
+	} | null,
+	inner?: (string | Node) | null,
 ): T;
 /**
  * @description Create text node
@@ -32,61 +41,61 @@ export function createTextNode(text: string): Text;
 /**
  * @description Get attributes of argument element to string ('class="---" name="---" ')
  * @param {Node} element Element object
- * @param {Array<string>|null} exceptAttrs Array of attribute names to exclude from the result
+ * @param {?Array<string>} exceptAttrs Array of attribute names to exclude from the result
  * @returns {string}
  */
 export function getAttributesToString(element: Node, exceptAttrs: Array<string> | null): string;
 /**
  * @description Get the items array from the array that matches the condition.
- * @param {__se__NodeCollection} array Array to get item
+ * @param {SunEditor.NodeCollection} array Array to get item
  * @param {?(current: *) => boolean} validation Conditional function
  * @returns {Array<Node>|null}
  */
-export function arrayFilter(array: __se__NodeCollection, validation: ((current: any) => boolean) | null): Array<Node> | null;
+export function arrayFilter(array: SunEditor.NodeCollection, validation: ((current: any) => boolean) | null): Array<Node> | null;
 /**
  * @description Get the item from the array that matches the condition.
- * @param {__se__NodeCollection} array Array to get item
+ * @param {SunEditor.NodeCollection} array Array to get item
  * @param {?(current: *) => boolean} validation Conditional function
  * @returns {Node|null}
  */
-export function arrayFind(array: __se__NodeCollection, validation: ((current: any) => boolean) | null): Node | null;
+export function arrayFind(array: SunEditor.NodeCollection, validation: ((current: any) => boolean) | null): Node | null;
 /**
  * @description Check if an array contains an element
- * @param {__se__NodeCollection} array element array
+ * @param {SunEditor.NodeCollection} array element array
  * @param {Node} node The node to check for
  * @returns {boolean}
  */
-export function arrayIncludes(array: __se__NodeCollection, node: Node): boolean;
+export function arrayIncludes(array: SunEditor.NodeCollection, node: Node): boolean;
 /**
  * @description Get the index of the argument value in the element array
- * @param {__se__NodeCollection} array element array
+ * @param {SunEditor.NodeCollection} array element array
  * @param {Node} node The element to find index
  * @returns {number}
  */
-export function getArrayIndex(array: __se__NodeCollection, node: Node): number;
+export function getArrayIndex(array: SunEditor.NodeCollection, node: Node): number;
 /**
  * @description Get the next index of the argument value in the element array
- * @param {__se__NodeCollection} array element array
+ * @param {SunEditor.NodeCollection} array element array
  * @param {Node} item The element to find index
  * @returns {number}
  */
-export function nextIndex(array: __se__NodeCollection, item: Node): number;
+export function nextIndex(array: SunEditor.NodeCollection, item: Node): number;
 /**
  * @description Get the previous index of the argument value in the element array
- * @param {__se__NodeCollection} array Element array
+ * @param {SunEditor.NodeCollection} array Element array
  * @param {Node} item The element to find index
  * @returns {number}
  */
-export function prevIndex(array: __se__NodeCollection, item: Node): number;
+export function prevIndex(array: SunEditor.NodeCollection, item: Node): number;
 /**
  * @description Add style and className of copyEl to originEl
  * @param {Node} originEl Origin element
  * @param {Node} copyEl Element to copy
- * @param {?Array<string>=} blacklist Blacklist array(LowerCase)
+ * @param {?Array<string>} [blacklist] Blacklist array(LowerCase)
  */
-export function copyTagAttributes(originEl: Node, copyEl: Node, blacklist?: (Array<string> | null) | undefined): void;
+export function copyTagAttributes(originEl: Node, copyEl: Node, blacklist?: Array<string> | null): void;
 /**
- * @description Copy and apply attributes of format tag that should be maintained. (style, class) Ignore "__se__format__" class
+ * @description Copy and apply attributes of format tag that should be maintained. (style, class) Ignore `__se__format__` class
  * @param {Node} originEl Origin element
  * @param {Node} copyEl Element to copy
  */
@@ -111,24 +120,24 @@ export function changeTxt(node: Node, txt: string): void;
 /**
  * @description Set style, if all styles are deleted, the style properties are deleted.
  * @param {Node|Node[]} elements Element to set style
- * @param {string} styleName Style attribute name (marginLeft, textAlign...)
+ * @param {string} styleName Style attribute name (`marginLeft`, `textAlign`...)
  * @param {string|number} value Style value
  */
 export function setStyle(elements: Node | Node[], styleName: string, value: string | number): void;
 /**
  * @description Gets the style value of the element. If the elements is an array, the style of the first element is returned.
  * @param {Node} element Element to get style from.
- * @param {string} styleName Style attribute name (e.g., 'marginLeft', 'textAlign').
- * @returns {string | undefined} The value of the style attribute, or undefined if the element does not exist.
+ * @param {string} styleName Style attribute name (e.g., `marginLeft`, `textAlign`).
+ * @returns {string | undefined} The value of the style attribute, or `undefined` if the element does not exist.
  */
 export function getStyle(element: Node, styleName: string): string | undefined;
 /**
- * @description In the predefined code view mode, the buttons except the executable button are changed to the 'disabled' state.
- * @param {Array<HTMLButtonElement|HTMLInputElement>} buttonList (Button | Input) Element array
+ * @description In the predefined code view mode, the buttons except the executable button are changed to the `disabled` state.
+ * @param {SunEditor.NodeCollection} buttonList (Button | Input) Element array
  * @param {boolean} disabled Disabled value
  * @param {boolean} [important=false] If priveleged mode should be used (Necessary to switch importantDisabled buttons)
  */
-export function setDisabled(buttonList: Array<HTMLButtonElement | HTMLInputElement>, disabled: boolean, important?: boolean): void;
+export function setDisabled(buttonList: SunEditor.NodeCollection, disabled: boolean, important?: boolean): void;
 /**
  * @description Determine whether any of the matched elements are assigned the given class
  * @param {?Node} element Elements to search class name
@@ -138,16 +147,16 @@ export function setDisabled(buttonList: Array<HTMLButtonElement | HTMLInputEleme
 export function hasClass(element: Node | null, className: string): boolean;
 /**
  * @description Append the className value of the argument value element
- * @param {Node|__se__NodeCollection} element Elements to add class name
+ * @param {Node|SunEditor.NodeCollection} element Elements to add class name
  * @param {string} className Class name to be add
  */
-export function addClass(element: Node | __se__NodeCollection, className: string): void;
+export function addClass(element: Node | SunEditor.NodeCollection, className: string): void;
 /**
  * @description Delete the className value of the argument value element
- * @param {Node|__se__NodeCollection} element Elements to remove class name
+ * @param {Node|SunEditor.NodeCollection} element Elements to remove class name
  * @param {string} className Class name to be remove
  */
-export function removeClass(element: Node | __se__NodeCollection, className: string): void;
+export function removeClass(element: Node | SunEditor.NodeCollection, className: string): void;
 /**
  * @description Argument value If there is no class name, insert it and delete the class name if it exists
  * @param {Node} element Element to replace class name
@@ -181,13 +190,13 @@ export function getViewportSize(): {
 	scale: number;
 };
 /**
- * @description Copies the "wwTarget" element and returns it with inline all styles applied.
- * @param {Node} wwTarget Target element to copy(.sun-editor.sun-editor-editable)
- * @param {boolean} includeWW Include the "wwTarget" element in the copy
- * @param {Array<string>} styles Style list - kamel case
+ * @description Copies the `wwTarget` element and returns it with inline all styles applied.
+ * @param {Node} wwTarget Target element to copy(`.sun-editor.sun-editor-editable`)
+ * @param {boolean} includeWW Include the `wwTarget` element in the copy
+ * @param {Iterable<string>} styles Style list - kamel case
  * @returns
  */
-export function applyInlineStylesAll(wwTarget: Node, includeWW: boolean, styles: Array<string>): HTMLElement;
+export function applyInlineStylesAll(wwTarget: Node, includeWW: boolean, styles: Iterable<string>): HTMLElement;
 /**
  * @description Wait for media elements to load
  * @param {Node} target Target element
@@ -195,6 +204,18 @@ export function applyInlineStylesAll(wwTarget: Node, includeWW: boolean, styles:
  * @returns {Promise<void>}
  */
 export function waitForMediaLoad(target: Node, timeout?: number): Promise<void>;
+/**
+ * @description Gets a CSS variable on the root element of the editor.
+ * @param {string} name - The CSS variable name (e.g. `--se-color-primary`)
+ * @return {string} The value of the CSS variable
+ */
+export function getRootCssVar(name: string): string;
+/**
+ * @description Sets a CSS variable on the root element of the editor.
+ * @param {string} name - The CSS variable name (e.g. `--se-color-primary`)
+ * @param {string} value - The CSS variable value
+ */
+export function setRootCssVar(name: string, value: string): void;
 /**
  * @description Create tooltip HTML
  * @param {string} text Tooltip text
@@ -230,5 +251,7 @@ declare namespace utils {
 	export { getViewportSize };
 	export { applyInlineStylesAll };
 	export { waitForMediaLoad };
+	export { getRootCssVar };
+	export { setRootCssVar };
 	export { createTooltipInner };
 }

package/types/helper/dom/index.d.ts

@@ -1,9 +1,95 @@
+import type {} from '../../typedef';
+export const domQuery: {
+	getPositionIndex: typeof import('./domQuery').getPositionIndex;
+	getNodePath: typeof import('./domQuery').getNodePath;
+	getNodeFromPath: typeof import('./domQuery').getNodeFromPath;
+	getChildNode: typeof import('./domQuery').getChildNode;
+	getListChildren: typeof import('./domQuery').getListChildren;
+	getListChildNodes: typeof import('./domQuery').getListChildNodes;
+	getNodeDepth: typeof import('./domQuery').getNodeDepth;
+	sortNodeByDepth: typeof import('./domQuery').sortNodeByDepth;
+	compareElements: typeof import('./domQuery').compareElements;
+	getParentElement: typeof import('./domQuery').getParentElement;
+	getParentElements: typeof import('./domQuery').getParentElements;
+	getCommandTarget: typeof import('./domQuery').getCommandTarget;
+	getEventTarget: typeof import('./domQuery').getEventTarget;
+	getEdgeChild: typeof import('./domQuery').getEdgeChild;
+	getEdgeChildNodes: typeof import('./domQuery').getEdgeChildNodes;
+	getPreviousDeepestNode: typeof import('./domQuery').getPreviousDeepestNode;
+	getNextDeepestNode: typeof import('./domQuery').getNextDeepestNode;
+	findTextIndexOnLine: typeof import('./domQuery').findTextIndexOnLine;
+	findTabEndIndex: typeof import('./domQuery').findTabEndIndex;
+	findVisualLastCell: typeof import('./domQuery').findVisualLastCell;
+	getScrollParents: typeof import('./domQuery').getScrollParents;
+	getIframeDocument: typeof import('./domQuery').getIframeDocument;
+};
+export const domCheck: {
+	isZeroWidth: typeof import('./domCheck').isZeroWidth;
+	isEdgePoint: typeof import('./domCheck').isEdgePoint;
+	isText: typeof import('./domCheck').isText;
+	isElement: typeof import('./domCheck').isElement;
+	isInputElement: typeof import('./domCheck').isInputElement;
+	isButtonElement: typeof import('./domCheck').isButtonElement;
+	isList: typeof import('./domCheck').isList;
+	isListCell: typeof import('./domCheck').isListCell;
+	isTable: typeof import('./domCheck').isTable;
+	isTableElements: typeof import('./domCheck').isTableElements;
+	isTableCell: typeof import('./domCheck').isTableCell;
+	isTableRow: typeof import('./domCheck').isTableRow;
+	isBreak: typeof import('./domCheck').isBreak;
+	isAnchor: typeof import('./domCheck').isAnchor;
+	isMedia: typeof import('./domCheck').isMedia;
+	isIFrame: typeof import('./domCheck').isIFrame;
+	isFigure: typeof import('./domCheck').isFigure;
+	isContentLess: typeof import('./domCheck').isContentLess;
+	isEmptyLine: typeof import('./domCheck').isEmptyLine;
+	isComponentContainer: typeof import('./domCheck').isComponentContainer;
+	isWysiwygFrame: typeof import('./domCheck').isWysiwygFrame;
+	isNonEditable: typeof import('./domCheck').isNonEditable;
+	isSpanWithoutAttr: typeof import('./domCheck').isSpanWithoutAttr;
+	isSameAttributes: typeof import('./domCheck').isSameAttributes;
+	isExcludeFormat: typeof import('./domCheck').isExcludeFormat;
+	isUneditable: typeof import('./domCheck').isUneditable;
+	isImportantDisabled: typeof import('./domCheck').isImportantDisabled;
+};
+export const domUtils: {
+	clone: typeof import('./domUtils').clone;
+	createElement: typeof import('./domUtils').createElement;
+	createTextNode: typeof import('./domUtils').createTextNode;
+	getAttributesToString: typeof import('./domUtils').getAttributesToString;
+	arrayFilter: typeof import('./domUtils').arrayFilter;
+	arrayFind: typeof import('./domUtils').arrayFind;
+	arrayIncludes: typeof import('./domUtils').arrayIncludes;
+	getArrayIndex: typeof import('./domUtils').getArrayIndex;
+	nextIndex: typeof import('./domUtils').nextIndex;
+	prevIndex: typeof import('./domUtils').prevIndex;
+	copyTagAttributes: typeof import('./domUtils').copyTagAttributes;
+	copyFormatAttributes: typeof import('./domUtils').copyFormatAttributes;
+	removeItem: typeof import('./domUtils').removeItem;
+	changeElement: typeof import('./domUtils').changeElement;
+	changeTxt: typeof import('./domUtils').changeTxt;
+	setStyle: typeof import('./domUtils').setStyle;
+	getStyle: typeof import('./domUtils').getStyle;
+	setDisabled: typeof import('./domUtils').setDisabled;
+	hasClass: typeof import('./domUtils').hasClass;
+	addClass: typeof import('./domUtils').addClass;
+	removeClass: typeof import('./domUtils').removeClass;
+	toggleClass: typeof import('./domUtils').toggleClass;
+	flashClass: typeof import('./domUtils').flashClass;
+	getClientSize: typeof import('./domUtils').getClientSize;
+	getViewportSize: typeof import('./domUtils').getViewportSize;
+	applyInlineStylesAll: typeof import('./domUtils').applyInlineStylesAll;
+	waitForMediaLoad: typeof import('./domUtils').waitForMediaLoad;
+	getRootCssVar: typeof import('./domUtils').getRootCssVar;
+	setRootCssVar: typeof import('./domUtils').setRootCssVar;
+	createTooltipInner: typeof import('./domUtils').createTooltipInner;
+};
 export default dom;
 declare namespace dom {
 	export { query };
 	export { check };
 	export { utils };
 }
-import query from './domQuery';
 import check from './domCheck';
+import query from './domQuery';
 import utils from './domUtils';

package/types/helper/env.d.ts

@@ -1,12 +1,13 @@
+import type {} from '../typedef';
 /**
- * @description Gets XMLHttpRequest object
+ * @description Gets `XMLHttpRequest` object
  * @returns {XMLHttpRequest}
  */
 export function getXMLHttpRequest(): XMLHttpRequest;
 /**
  * @deprecated
  * @description Returns the CSS text that has been applied to the current page.
- * @param {Document|null} doc To get the CSS text of an document. If null get the current document.
+ * @param {?Document} doc To get the CSS text of an document. If `null` get the current document.
  * @returns {string} Styles string
  */
 export function getPageStyle(doc: Document | null): string;
@@ -15,14 +16,11 @@ export function getPageStyle(doc: Document | null): string;
  * @description Get the the tag path of the arguments value
  * @param {Array<string>} nameArray File name array
  * @param {string} extension js, css
- * @returns {string} If not found, return the first found value
+ * @returns {string} If not found, return the first found value.
  */
 export function getIncludePath(nameArray: Array<string>, extension: string): string;
-/**
- * @fileoverview Environment  helper functions
- */
-/** @type {Window} */
-export const _w: Window;
+/** @type {SunEditor.GlobalWindow} */
+export const _w: SunEditor.GlobalWindow;
 /** @type {Document} */
 export const _d: Document;
 /**
@@ -37,13 +35,13 @@ export const NO_EVENT: symbol;
 export const ON_OVER_COMPONENT: symbol;
 /** --- Check browser --- */
 /**
- * @description Check if support ResizeObserver function
- * @returns {boolean} Whether support ResizeObserver function or not.
+ * @description Check if support `ResizeObserver` function
+ * @returns {boolean} Whether support `ResizeObserver` function or not.
  */
 export const isResizeObserverSupported: boolean;
 /**
- * @description Check if support navigator.clipboard
- * @returns {boolean} Whether support navigator.clipboard or not.
+ * @description Check if support `navigator.clipboard`
+ * @returns {boolean} Whether support `navigator.clipboard` or not.
  */
 export const isClipboardSupported: boolean;
 /**
@@ -78,10 +76,14 @@ export const isChromium: boolean;
 export const isSafari: boolean;
 /**
  * @description Check if User Agent is Mobile device.
- * - when the device is touchable, it is judged as a mobile device.
  * @type {boolean}
  */
 export const isMobile: boolean;
+/**
+ * @description Check if the device is touchable.
+ * @type {boolean}
+ */
+export const isTouchDevice: boolean;
 /**
  * @description Check if User Agent is Android mobile device.
  * @type {boolean}
@@ -124,6 +126,7 @@ declare namespace env {
 	export { isOSX_IOS };
 	export { isAndroid };
 	export { isMobile };
+	export { isTouchDevice };
 	export { cmdIcon };
 	export { shiftIcon };
 	export { DPI };

package/types/helper/index.d.ts

@@ -1,5 +1,6 @@
+import type {} from '../typedef';
 export const env: {
-	_w: Window;
+	_w: SunEditor.GlobalWindow;
 	_d: Document;
 	NO_EVENT: symbol;
 	ON_OVER_COMPONENT: symbol;
@@ -16,6 +17,7 @@ export const env: {
 	isOSX_IOS: boolean;
 	isAndroid: boolean;
 	isMobile: boolean;
+	isTouchDevice: boolean;
 	cmdIcon: string;
 	shiftIcon: string;
 	DPI: number;
@@ -59,6 +61,7 @@ export const dom: {
 		getPositionIndex: typeof import('./dom/domQuery').getPositionIndex;
 		getNodePath: typeof import('./dom/domQuery').getNodePath;
 		getNodeFromPath: typeof import('./dom/domQuery').getNodeFromPath;
+		getChildNode: typeof import('./dom/domQuery').getChildNode;
 		getListChildren: typeof import('./dom/domQuery').getListChildren;
 		getListChildNodes: typeof import('./dom/domQuery').getListChildNodes;
 		getNodeDepth: typeof import('./dom/domQuery').getNodeDepth;
@@ -75,7 +78,7 @@ export const dom: {
 		findTextIndexOnLine: typeof import('./dom/domQuery').findTextIndexOnLine;
 		findTabEndIndex: typeof import('./dom/domQuery').findTabEndIndex;
 		findVisualLastCell: typeof import('./dom/domQuery').findVisualLastCell;
-		getScrollParent: typeof import('./dom/domQuery').getScrollParent;
+		getScrollParents: typeof import('./dom/domQuery').getScrollParents;
 		getIframeDocument: typeof import('./dom/domQuery').getIframeDocument;
 	};
 	check: {
@@ -98,6 +101,7 @@ export const dom: {
 		isFigure: typeof import('./dom/domCheck').isFigure;
 		isContentLess: typeof import('./dom/domCheck').isContentLess;
 		isEmptyLine: typeof import('./dom/domCheck').isEmptyLine;
+		isComponentContainer: typeof import('./dom/domCheck').isComponentContainer;
 		isWysiwygFrame: typeof import('./dom/domCheck').isWysiwygFrame;
 		isNonEditable: typeof import('./dom/domCheck').isNonEditable;
 		isSpanWithoutAttr: typeof import('./dom/domCheck').isSpanWithoutAttr;
@@ -134,6 +138,8 @@ export const dom: {
 		getViewportSize: typeof import('./dom/domUtils').getViewportSize;
 		applyInlineStylesAll: typeof import('./dom/domUtils').applyInlineStylesAll;
 		waitForMediaLoad: typeof import('./dom/domUtils').waitForMediaLoad;
+		getRootCssVar: typeof import('./dom/domUtils').getRootCssVar;
+		setRootCssVar: typeof import('./dom/domUtils').setRootCssVar;
 		createTooltipInner: typeof import('./dom/domUtils').createTooltipInner;
 	};
 };

package/types/helper/keyCodeMap.d.ts

@@ -1,92 +1,93 @@
+import type {} from '../typedef';
 /** ------------------------------------------------------- [meta] -------------------------------------------------------  */
 /**
- * @description Shift check
+ * @description `Shift` check
  * @param {KeyboardEvent} e Event object
  * @returns {boolean}
  */
 export function isShift(e: KeyboardEvent): boolean;
 /**
- * @description [Ctrl|Meta] check
+ * @description [`Ctrl`|`Meta`] check
  * @param {KeyboardEvent} e Event object
  * @returns {boolean}
  */
 export function isCtrl(e: KeyboardEvent): boolean;
 /**
- * @description Alt check
+ * @description `Alt` check
  * @param {KeyboardEvent} e Event object
  * @returns {boolean}
  */
 export function isAlt(e: KeyboardEvent): boolean;
 /**
- * @description event.isComposing check
- * @param {KeyboardEvent} e Event object
+ * @description Check if the event is related to IME composition (in-progress or commit).
+ * @param {KeyboardEvent|InputEvent} e Event object
  * @returns {boolean}
  */
-export function isComposing(e: KeyboardEvent): boolean;
+export function isComposing(e: KeyboardEvent | InputEvent): boolean;
 /**
- * @description Backspace key check
- * @param {string} code Event.code
+ * @description `Backspace` key check
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isBackspace(code: string): boolean;
 /**
- * @description Tab key check
- * @param {string} code Event.code
+ * @description `Tab` key check
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isTab(code: string): boolean;
 /**
- * @description Enter key check
- * @param {string} code Event.code
+ * @description `Enter` key check
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isEnter(code: string): boolean;
 /**
- * @description ESC key check
- * @param {string} code Event.code
+ * @description `ESC` key check
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isEsc(code: string): boolean;
 /**
- * @description Space key check
- * @param {string} code Event.code
+ * @description `Space` key check
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isSpace(code: string): boolean;
 /** ------------------------------------------------------- [key] -------------------------------------------------------  */
 /**
  * @description Direction key check
- * @param {string} code Event.code
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isDirectionKey(code: string): boolean;
 /**
- * @description [delete, backspace] key check
- * @param {string} code Event.code
+ * @description [`delete`, `backspace`] key check
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isRemoveKey(code: string): boolean;
 /**
  * @description Non-text key check
- * @param {string} code Event.code
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isNonTextKey(code: string): boolean;
 /**
  * @description Check if the given key is relevant for history push
- * @param {string} code - Event.code
+ * @param {string} code - `Event.code`
  * @returns {boolean}
  */
 export function isHistoryRelevantKey(code: string): boolean;
 /**
  * @description Document type observer key check
- * @param {string} code Event.code
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isDocumentTypeObserverKey(code: string): boolean;
 /**
  * @description Non-response key check
- * @param {string} code Event.code
+ * @param {string} code `Event.code`
  * @returns {boolean}
  */
 export function isNonResponseKey(code: string): boolean;

package/types/helper/numbers.d.ts

@@ -1,6 +1,4 @@
-/**
- * @fileoverview Number-related helper functions
- */
+import type {} from '../typedef';
 /**
  * @description Checks for numeric (with decimal point).
  * @param {*} text Text string or number
@@ -10,13 +8,13 @@ export function is(text: any): boolean;
 /**
  * @description Get a number.
  * @param {string|number} value Text string or number
- * @param {number} [maxDec=0] Maximum number of decimal places (-1 : Infinity)
+ * @param {number} [maxDec=0] Maximum number of decimal places (`-1` : `Infinity`)
  * @returns {number}
  */
 export function get(value: string | number, maxDec?: number): number;
 /**
- * @description It compares the start and end indexes of 'a' and 'b' and returns the number of overlapping indexes in the range.
- * - e.g.) 1, 5, 4, 6 => '2' (4,5)
+ * @description It compares the start and end indexes of `a` and `b` and returns the number of overlapping indexes in the range.
+ * - e.g.) 1, 5, 4, 6 => `2` (4,5)
  * @param {number} aStart Start index of 'a'
  * @param {number} aEnd End index of 'a'
  * @param {number} bStart Start index of 'b'

package/types/helper/unicode.d.ts

@@ -1,3 +1,4 @@
+import type {} from '../typedef';
 /**
  * @description Escape a string for safe use in regular expressions.
  * @param {string} string String to escape
@@ -5,17 +6,17 @@
  */
 export function escapeStringRegexp(string: string): string;
 /**
- * @description Unicode Character 'ZERO WIDTH SPACE' (\u200B)
+ * @description Unicode Character `ZERO WIDTH SPACE` (`\u200B`)
  * @type {string}
  */
 export const zeroWidthSpace: string;
 /**
- * @description Regular expression to find 'zero width space' (/\u200B/g)
+ * @description Regular expression to find `zero width space` (`/\u200B/g`)
  * @type {RegExp}
  */
 export const zeroWidthRegExp: RegExp;
 /**
- * @description Regular expression to find only 'zero width space' (/\u200B/g)
+ * @description Regular expression to find only `zero width space` (`/\u200B/g`)
  * @type {RegExp}
  */
 export const onlyZeroWidthRegExp: RegExp;