Skip to main content
Module

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

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

Remove a matching text property from line {lnum}. When {lnum-end} is given, remove matching text properties from line {lnum} to {lnum-end} (inclusive). When {lnum} is omitted remove matching text properties from all lines (this requires going over all lines, thus will be a bit slow for a buffer with many lines).

{props} is a dictionary with these fields: id remove text properties with this ID type remove text properties with this type name types remove text properties with type names in this List both "id" and "type"/"types" must both match bufnr use this buffer instead of the current one all when TRUE remove all matching text properties, not just the first one Only one of "type" and "types" may be supplied.

A property matches when either "id" or one of the supplied types matches. If buffer "bufnr" does not exist you get an error message. If buffer "bufnr" is not loaded then nothing happens.

Returns the number of properties that were removed.

Can also be used as a method:

GetProps()->prop_remove()

Parameters

denops: Denops
props: unknown
optional
lnum: unknown
optional
lnum_end: unknown

Returns

Promise<number>