Skip to main content
Module

x/denops_std/function/vim/mod.ts>hlget

📚 Standard module for denops.vim
Go to Latest
function hlget
import { hlget } from "https://deno.land/x/denops_std@v6.4.0/function/vim/mod.ts";

Returns a List of all the highlight group attributes. If the optional {name} is specified, then returns a List with only the attributes of the specified highlight group. Returns an empty List if the highlight group {name} is not present.

If the optional {resolve} argument is set to v:true and the highlight group {name} is linked to another group, then the link is resolved recursively and the attributes of the resolved highlight group are returned.

Each entry in the returned List is a Dictionary with the following items: cleared boolean flag, set to v:true if the highlight group attributes are cleared or not yet specified. See highlight-clear. cterm cterm attributes. See highlight-cterm. ctermbg cterm background color. See highlight-ctermbg. ctermfg cterm foreground color. See highlight-ctermfg. ctermul cterm underline color. See highlight-ctermul. default boolean flag, set to v:true if the highlight group link is a default link. See highlight-default. font highlight group font. See highlight-font. gui gui attributes. See highlight-gui. guibg gui background color. See highlight-guibg. guifg gui foreground color. See highlight-guifg. guisp gui special color. See highlight-guisp. id highlight group ID. linksto linked highlight group name. See :highlight-link. name highlight group name. See group-name. start start terminal keycode. See highlight-start. stop stop terminal keycode. See highlight-stop. term term attributes. See highlight-term.

The 'term', 'cterm' and 'gui' items in the above Dictionary have a dictionary value with the following optional boolean items: 'bold', 'standout', 'underline', 'undercurl', 'italic', 'reverse', 'inverse' and 'strikethrough'.

Example(s):

:echo hlget()
:echo hlget('ModeMsg')
:echo hlget('Number', v:true)

Can also be used as a method:

GetName()->hlget()

Parameters

denops: Denops
optional
name: unknown
optional
resolve: unknown

Returns

Promise<unknown[]>