Class StyleHover

Index

Constructors

Methods

getPrefix setPrefix getColor setColor isUnderline setUnderline isItalic setItalic toJson

Properties

prefix? color? underline? italic?

Constructors

constructor

new StyleHover(
    prefix?: string,
    color?: ColorName,
    underline?: boolean,
    italic?: boolean,
): StyleHover
Creates a new hover style with optional customization.
Parameters
- Optionalprefix: string
  Optional prefix string.
- Optionalcolor: ColorName
  Optional chalk color name.
- Optionalunderline: boolean
  Optional underline flag.
- Optionalitalic: boolean
  Optional italic flag.
Returns StyleHover
- Defined in styles/hover.ts:23

Methods

getPrefix

getPrefix(): string | undefined
Returns the prefix string displayed before the item label, or undefined to use the env default.

Returns string | undefined
- Defined in styles/hover.ts:36

setPrefix

setPrefix(prefix: string | undefined): this
Sets the prefix string. Non-empty values are accepted; empty strings are ignored.
Parameters
- prefix: string | undefined
  Prefix to display before the label.
Returns this
- Defined in styles/hover.ts:44

getColor

getColor(): ColorName | undefined
Returns the chalk color for this style, or undefined to use the terminal default.

Returns ColorName | undefined
- Defined in styles/hover.ts:52

setColor

setColor(color: ColorName | undefined): this
Sets the chalk color for this style.
Parameters
- color: ColorName | undefined
  Chalk color name, or undefined to use the terminal default.
Returns this
- Defined in styles/hover.ts:60

isUnderline

isUnderline(): boolean | undefined
Returns the underline flag, or undefined if not explicitly set.

Returns boolean | undefined
- Defined in styles/hover.ts:66

setUnderline

setUnderline(underline: boolean | undefined): this
Sets whether the text should be underlined.
Parameters
- underline: boolean | undefined
Returns this
- Defined in styles/hover.ts:71

isItalic

isItalic(): boolean | undefined
Returns the italic flag, or undefined if not explicitly set.

Returns boolean | undefined
- Defined in styles/hover.ts:77

setItalic

setItalic(italic: boolean | undefined): this
Sets whether the text should be italic.
Parameters
- italic: boolean | undefined
Returns this
- Defined in styles/hover.ts:82

toJson

toJson(): StyleHoverJson
Serialises the hover style to a plain JSON-compatible object.

Returns StyleHoverJson
- Defined in styles/hover.ts:88

Properties

`Protected` `Optional`prefix

prefix?: string

`Protected` `Optional`color

color?: ColorName

`Protected` `Optional`underline

underline?: boolean

`Protected` `Optional`italic

italic?: boolean