hlID | /function/mod.ts | denops_std@v6.4.0

Module

x/denops_std/function/mod.ts>hlID

📚 Standard module for denops.vim

vim-denops/deno-denops-std

Very Popular

Go to Latest

nvim vim

mod.ts (default module)

abs

add

and

col

cos

exp

get

has

isValidBuiltinCompletion

len

log

map

max

min

pow

sin

tan

has

col

isValidBuiltinCompletion

various.ts

mode

function hlID

import { hlID } from "https://deno.land/x/denops_std@v6.4.0/function/mod.ts";

hlID(denops: Denops, name: unknown): Promise<number>

The result is a Number, which is the ID of the highlight group with name {name}. When the highlight group doesn't exist, zero is returned. This can be used to retrieve information about the highlight group. For example, to get the background color of the "Comment" group:

:echo synIDattr(synIDtrans(hlID("Comment")), "bg")

Obsolete name: highlightID().

Can also be used as a method:

GetName()->hlID()

Parameters

denops: Denops

name: unknown

Returns

Promise<number>