-
Notifications
You must be signed in to change notification settings - Fork 15
/
_generated.ts
5518 lines (5318 loc) Β· 165 KB
/
_generated.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// NOTE: This file is generated. Do NOT modify it manually.
// deno-lint-ignore-file camelcase
import type { Denops } from "https://deno.land/x/denops_core@v6.0.5/mod.ts";
/**
* Find files in runtime directories
*
* Attributes:
* `api-fast`
*
* Parameters:
* - **{pat}** pattern of files to search for
* - **{all}** whether to return all matches or only the first
* - **{opts}** is_lua: only search lua subdirs
*
* Return:
* list of absolute paths to the found files
*/
export function nvim__get_runtime(
denops: Denops,
pat: unknown,
all: unknown,
opts: unknown,
): Promise<unknown>;
export function nvim__get_runtime(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim__get_runtime", ...args);
}
/**
* Returns object given as argument.
*
* This API function is used for testing. One should not rely on its presence
* in plugins.
*
* Parameters:
* - **{obj}** Object to return.
*
* Return:
* its argument.
*/
export function nvim__id(denops: Denops, obj: unknown): Promise<unknown>;
export function nvim__id(denops: Denops, ...args: unknown[]): Promise<unknown> {
return denops.call("nvim__id", ...args);
}
/**
* Returns array given as argument.
*
* This API function is used for testing. One should not rely on its presence
* in plugins.
*
* Parameters:
* - **{arr}** Array to return.
*
* Return:
* its argument.
*/
export function nvim__id_array(denops: Denops, arr: unknown): Promise<unknown>;
export function nvim__id_array(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim__id_array", ...args);
}
/**
* Returns dictionary given as argument.
*
* This API function is used for testing. One should not rely on its presence
* in plugins.
*
* Parameters:
* - **{dct}** Dictionary to return.
*
* Return:
* its argument.
*/
export function nvim__id_dictionary(
denops: Denops,
dct: unknown,
): Promise<unknown>;
export function nvim__id_dictionary(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim__id_dictionary", ...args);
}
/**
* Returns floating-point value given as argument.
*
* This API function is used for testing. One should not rely on its presence
* in plugins.
*
* Parameters:
* - **{flt}** Value to return.
*
* Return:
* its argument.
*/
export function nvim__id_float(denops: Denops, flt: unknown): Promise<unknown>;
export function nvim__id_float(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim__id_float", ...args);
}
/**
* NB: if your UI doesn't use hlstate, this will not return hlstate first
* time.
*/
export function nvim__inspect_cell(
denops: Denops,
grid: unknown,
row: unknown,
col: unknown,
): Promise<unknown>;
export function nvim__inspect_cell(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim__inspect_cell", ...args);
}
/**
* Gets internal stats.
*
* Return:
* Map of various internal stats.
*/
export function nvim__stats(denops: Denops): Promise<unknown>;
export function nvim__stats(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim__stats", ...args);
}
/**
* Calls many API methods atomically.
*
* This has two main usages:
* 1. To perform several requests from an async context atomically, i.e.
* without interleaving redraws, RPC requests from other clients, or user
* interactions (however API methods may trigger autocommands or event
* processing which have such side effects, e.g. `:sleep` may wake
* timers).
* 2. To minimize RPC overhead (roundtrips) of a sequence of many requests.
*
* Attributes:
* `RPC` only
*
* Parameters:
* - **{calls}** an array of calls, where each call is described by an array
* with two elements: the request name, and an array of
* arguments.
*
* Return:
* Array of two elements. The first is an array of return values. The
* second is NIL if all calls succeeded. If a call resulted in an error,
* it is a three-element array with the zero-based index of the call
* which resulted in an error, the error type and the error message. If
* an error occurred, the values from all preceding calls will still be
* returned.
*/
export function nvim_call_atomic(
denops: Denops,
calls: unknown,
): Promise<unknown>;
export function nvim_call_atomic(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_call_atomic", ...args);
}
/**
* Send data to channel `id`. For a job, it writes it to the stdin of the
* process. For the stdio channel `channel-stdio`, it writes to Nvim's
* stdout. For an internal terminal instance (`nvim_open_term()`) it writes
* directly to terminal output. See `channel-bytes` for more information.
*
* This function writes raw data, not RPC messages. If the channel was
* created with `rpc=true` then the channel expects RPC messages, use
* `vim.rpcnotify()` and `vim.rpcrequest()` instead.
*
* Attributes:
* `RPC` only
* Lua `vim.api` only
*
* Parameters:
* - **{chan}** id of the channel
* - **{data}** data to write. 8-bit clean: can contain NUL bytes.
*/
export function nvim_chan_send(
denops: Denops,
chan: unknown,
data: unknown,
): Promise<unknown>;
export function nvim_chan_send(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_chan_send", ...args);
}
/**
* Creates a new, empty, unnamed buffer.
*
* Parameters:
* - **{listed}** Sets 'buflisted'
* - **{scratch}** Creates a "throwaway" `scratch-buffer` for temporary work
* (always 'nomodified'). Also sets 'nomodeline' on the
* buffer.
*
* Return:
* Buffer handle, or 0 on error
*
* See also:
* - buf_open_scratch
*/
export function nvim_create_buf(
denops: Denops,
listed: unknown,
scratch: unknown,
): Promise<unknown>;
export function nvim_create_buf(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_create_buf", ...args);
}
/**
* Deletes the current line.
*
* Attributes:
* not allowed when `textlock` is active
*/
export function nvim_del_current_line(denops: Denops): Promise<unknown>;
export function nvim_del_current_line(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_del_current_line", ...args);
}
/**
* Unmaps a global `mapping` for the given mode.
*
* To unmap a buffer-local mapping, use `nvim_buf_del_keymap()`.
*
* See also:
* - `nvim_set_keymap()`
*/
export function nvim_del_keymap(
denops: Denops,
mode: unknown,
lhs: unknown,
): Promise<unknown>;
export function nvim_del_keymap(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_del_keymap", ...args);
}
/**
* Deletes an uppercase/file named mark. See `mark-motions`.
*
* Note:
* fails with error if a lowercase or buffer local named mark is used.
*
* Parameters:
* - **{name}** Mark name
*
* Return:
* true if the mark was deleted, else false.
*
* See also:
* - `nvim_buf_del_mark()`
* - `nvim_get_mark()`
*/
export function nvim_del_mark(denops: Denops, name: unknown): Promise<unknown>;
export function nvim_del_mark(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_del_mark", ...args);
}
/**
* Removes a global (g:) variable.
*
* Parameters:
* - **{name}** Variable name
*/
export function nvim_del_var(denops: Denops, name: unknown): Promise<unknown>;
export function nvim_del_var(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_del_var", ...args);
}
/**
* Echo a message.
*
* Parameters:
* - **{chunks}** A list of [text, hl_group] arrays, each representing a text
* chunk with specified highlight. `hl_group` element can be
* omitted for no highlight.
* - **{history}** if true, add to `message-history`.
* - **{opts}** Optional parameters.
* - verbose: Message was printed as a result of 'verbose'
* option if Nvim was invoked with -V3log_file, the message
* will be redirected to the log_file and suppressed from
* direct output.
*/
export function nvim_echo(
denops: Denops,
chunks: unknown,
history: unknown,
opts: unknown,
): Promise<unknown>;
export function nvim_echo(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_echo", ...args);
}
/**
* Writes a message to the Vim error buffer. Does not append "\n", the
* message is buffered (won't display) until a linefeed is written.
*
* Parameters:
* - **{str}** Message
*/
export function nvim_err_write(denops: Denops, str: unknown): Promise<unknown>;
export function nvim_err_write(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_err_write", ...args);
}
/**
* Writes a message to the Vim error buffer. Appends "\n", so the buffer is
* flushed (and displayed).
*
* Parameters:
* - **{str}** Message
*
* See also:
* - nvim_err_write()
*/
export function nvim_err_writeln(
denops: Denops,
str: unknown,
): Promise<unknown>;
export function nvim_err_writeln(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_err_writeln", ...args);
}
/**
* Evaluates statusline string.
*
* Attributes:
* `api-fast`
*
* Parameters:
* - **{str}** Statusline string (see 'statusline').
* - **{opts}** Optional parameters.
* - winid: (number) `window-ID` of the window to use as context
* for statusline.
* - maxwidth: (number) Maximum width of statusline.
* - fillchar: (string) Character to fill blank spaces in the
* statusline (see 'fillchars'). Treated as single-width even
* if it isn't.
* - highlights: (boolean) Return highlight information.
* - use_winbar: (boolean) Evaluate winbar instead of statusline.
* - use_tabline: (boolean) Evaluate tabline instead of
* statusline. When true, **{winid}** is ignored. Mutually
* exclusive with {use_winbar}.
* - use_statuscol_lnum: (number) Evaluate statuscolumn for this
* line number instead of statusline.
*
* Return:
* Dictionary containing statusline information, with these keys:
* - str: (string) Characters that will be displayed on the statusline.
* - width: (number) Display width of the statusline.
* - highlights: Array containing highlight information of the
* statusline. Only included when the "highlights" key in **{opts}** is
* true. Each element of the array is a `Dictionary` with these keys:
* - start: (number) Byte index (0-based) of first character that uses
* the highlight.
* - group: (string) Name of highlight group.
*/
export function nvim_eval_statusline(
denops: Denops,
str: unknown,
opts: unknown,
): Promise<unknown>;
export function nvim_eval_statusline(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_eval_statusline", ...args);
}
/**
* Execute Lua code. Parameters (if any) are available as `...` inside the
* chunk. The chunk can return a value.
*
* Only statements are executed. To evaluate an expression, prefix it with
* `return`: return my_function(...)
*
* Attributes:
* `RPC` only
*
* Parameters:
* - **{code}** Lua code to execute
* - **{args}** Arguments to the code
*
* Return:
* Return value of Lua code if present or NIL.
*/
export function nvim_exec_lua(
denops: Denops,
code: unknown,
args: unknown,
): Promise<unknown>;
export function nvim_exec_lua(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_exec_lua", ...args);
}
/**
* Sends input-keys to Nvim, subject to various quirks controlled by `mode`
* flags. This is a blocking call, unlike `nvim_input()`.
*
* On execution error: does not fail, but updates v:errmsg.
*
* To input sequences like `<C-o>` use `nvim_replace_termcodes()` (typically
* with escape_ks=false) to replace `keycodes`, then pass the result to
* nvim_feedkeys().
*
* Example: >vim
* :let key = nvim_replace_termcodes(`"<C-o>"`, v:true, v:false, v:true)
* :call nvim_feedkeys(key, 'n', v:false)
* <
*
* Parameters:
* - **{keys}** to be typed
* - **{mode}** behavior flags, see `feedkeys()`
* - {escape_ks} If true, escape K_SPECIAL bytes in `keys`. This should be
* false if you already used `nvim_replace_termcodes()`, and
* true otherwise.
*
* See also:
* - feedkeys()
* - vim_strsave_escape_ks
*/
export function nvim_feedkeys(
denops: Denops,
keys: unknown,
mode: unknown,
escape_ks: unknown,
): Promise<unknown>;
export function nvim_feedkeys(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_feedkeys", ...args);
}
/**
* Returns a 2-tuple (Array), where item 0 is the current channel id and item
* 1 is the `api-metadata` map (Dictionary).
*
* Return:
* 2-tuple [**{channel-id}**, **{api-metadata}**]
*
* Attributes:
* `api-fast`
* `RPC` only
*/
export function nvim_get_api_info(denops: Denops): Promise<unknown>;
export function nvim_get_api_info(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_api_info", ...args);
}
/**
* Gets information about a channel.
*
* Return:
* Dictionary describing a channel, with these keys:
* - "id" Channel id.
* - "argv" (optional) Job arguments list.
* - "stream" Stream underlying the channel.
* - "stdio" stdin and stdout of this Nvim instance
* - "stderr" stderr of this Nvim instance
* - "socket" TCP/IP socket or named pipe
* - "job" Job with communication over its stdio.
*
* - "mode" How data received on the channel is interpreted.
* - "bytes" Send and receive raw bytes.
* - "terminal" `terminal` instance interprets ASCII sequences.
* - "rpc" `RPC` communication on the channel is active.
*
* - "pty" (optional) Name of pseudoterminal. On a POSIX system this is a
* device path like "/dev/pts/1". If the name is unknown, the key will
* still be present if a pty is used (e.g. for conpty on Windows).
* - "buffer" (optional) Buffer with connected `terminal` instance.
* - "client" (optional) Info about the peer (client on the other end of
* the RPC channel), if provided by it via `nvim_set_client_info()`.
*/
export function nvim_get_chan_info(
denops: Denops,
chan: unknown,
): Promise<unknown>;
export function nvim_get_chan_info(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_chan_info", ...args);
}
/**
* Returns the 24-bit RGB value of a `nvim_get_color_map()` color name or
* "#rrggbb" hexadecimal string.
*
* Example: >vim
* :echo nvim_get_color_by_name("Pink")
* :echo nvim_get_color_by_name("#cbcbcb")
* <
*
* Parameters:
* - **{name}** Color name or "#rrggbb" string
*
* Return:
* 24-bit RGB value, or -1 for invalid argument.
*/
export function nvim_get_color_by_name(
denops: Denops,
name: unknown,
): Promise<unknown>;
export function nvim_get_color_by_name(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_color_by_name", ...args);
}
/**
* Returns a map of color names and RGB values.
*
* Keys are color names (e.g. "Aqua") and values are 24-bit RGB color values
* (e.g. 65535).
*
* Return:
* Map of color names and RGB values.
*/
export function nvim_get_color_map(denops: Denops): Promise<unknown>;
export function nvim_get_color_map(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_color_map", ...args);
}
/**
* Gets a map of the current editor state.
*
* Parameters:
* - **{opts}** Optional parameters.
* - types: List of `context-types` ("regs", "jumps", "bufs",
* "gvars", β¦) to gather, or empty for "all".
*
* Return:
* map of global `context`.
*/
export function nvim_get_context(
denops: Denops,
opts: unknown,
): Promise<unknown>;
export function nvim_get_context(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_context", ...args);
}
/**
* Gets the current buffer.
*
* Return:
* Buffer handle
*/
export function nvim_get_current_buf(denops: Denops): Promise<unknown>;
export function nvim_get_current_buf(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_current_buf", ...args);
}
/**
* Gets the current line.
*
* Return:
* Current line string
*/
export function nvim_get_current_line(denops: Denops): Promise<unknown>;
export function nvim_get_current_line(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_current_line", ...args);
}
/**
* Gets the current tabpage.
*
* Return:
* Tabpage handle
*/
export function nvim_get_current_tabpage(denops: Denops): Promise<unknown>;
export function nvim_get_current_tabpage(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_current_tabpage", ...args);
}
/**
* Gets the current window.
*
* Return:
* Window handle
*/
export function nvim_get_current_win(denops: Denops): Promise<unknown>;
export function nvim_get_current_win(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_current_win", ...args);
}
/**
* Gets all or specific highlight groups in a namespace.
*
* Parameters:
* - {ns_id} Get highlight groups for namespace ns_id
* `nvim_get_namespaces()`. Use 0 to get global highlight groups
* `:highlight`.
* - **{opts}** Options dict:
* - name: (string) Get a highlight definition by name.
* - id: (integer) Get a highlight definition by id.
* - link: (boolean, default true) Show linked group name
* instead of effective definition `:hi-link`.
*
* Return:
* Highlight groups as a map from group name to a highlight definition
* map as in `nvim_set_hl()`, or only a single highlight definition map
* if requested by name or id.
*
* Note:
* When the `link` attribute is defined in the highlight definition map,
* other attributes will not be taking effect (see `:hi-link`).
*/
export function nvim_get_hl(
denops: Denops,
ns_id: unknown,
opts: unknown,
): Promise<unknown>;
export function nvim_get_hl(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_hl", ...args);
}
/**
* Gets a highlight group by name
*
* similar to `hlID()`, but allocates a new ID if not present.
*/
export function nvim_get_hl_id_by_name(
denops: Denops,
name: unknown,
): Promise<unknown>;
export function nvim_get_hl_id_by_name(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_hl_id_by_name", ...args);
}
/**
* Gets a list of global (non-buffer-local) `mapping` definitions.
*
* Parameters:
* - **{mode}** Mode short-name ("n", "i", "v", ...)
*
* Return:
* Array of `maparg()`-like dictionaries describing mappings. The
* "buffer" key is always zero.
*/
export function nvim_get_keymap(
denops: Denops,
mode: unknown,
): Promise<unknown>;
export function nvim_get_keymap(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_keymap", ...args);
}
/**
* Return a tuple (row, col, buffer, buffername) representing the position of
* the uppercase/file named mark. See `mark-motions`.
*
* Marks are (1,0)-indexed. `api-indexing`
*
* Note:
* fails with error if a lowercase or buffer local named mark is used.
*
* Parameters:
* - **{name}** Mark name
* - **{opts}** Optional parameters. Reserved for future use.
*
* Return:
* 4-tuple (row, col, buffer, buffername), (0, 0, 0, '') if the mark is
* not set.
*
* See also:
* - `nvim_buf_set_mark()`
* - `nvim_del_mark()`
*/
export function nvim_get_mark(
denops: Denops,
name: unknown,
opts: unknown,
): Promise<unknown>;
export function nvim_get_mark(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_mark", ...args);
}
/**
* Gets the current mode. `mode()` "blocking" is true if Nvim is waiting for
* input.
*
* Return:
* Dictionary { "mode": String, "blocking": Boolean }
*
* Attributes:
* `api-fast`
*/
export function nvim_get_mode(denops: Denops): Promise<unknown>;
export function nvim_get_mode(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_mode", ...args);
}
/**
* Gets info describing process `pid`.
*
* Return:
* Map of process properties, or NIL if process not found.
*/
export function nvim_get_proc(denops: Denops, pid: unknown): Promise<unknown>;
export function nvim_get_proc(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_proc", ...args);
}
/**
* Gets the immediate children of process `pid`.
*
* Return:
* Array of child process ids, empty if process not found.
*/
export function nvim_get_proc_children(
denops: Denops,
pid: unknown,
): Promise<unknown>;
export function nvim_get_proc_children(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_proc_children", ...args);
}
/**
* Find files in runtime directories
*
* "name" can contain wildcards. For example
* nvim_get_runtime_file("colors/*.vim", true) will return all color scheme
* files. Always use forward slashes (/) in the search pattern for
* subdirectories regardless of platform.
*
* It is not an error to not find any files. An empty array is returned then.
*
* Attributes:
* `api-fast`
*
* Parameters:
* - **{name}** pattern of files to search for
* - **{all}** whether to return all matches or only the first
*
* Return:
* list of absolute paths to the found files
*/
export function nvim_get_runtime_file(
denops: Denops,
name: unknown,
all: unknown,
): Promise<unknown>;
export function nvim_get_runtime_file(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_runtime_file", ...args);
}
/**
* Gets a global (g:) variable.
*
* Parameters:
* - **{name}** Variable name
*
* Return:
* Variable value
*/
export function nvim_get_var(denops: Denops, name: unknown): Promise<unknown>;
export function nvim_get_var(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_var", ...args);
}
/**
* Gets a v: variable.
*
* Parameters:
* - **{name}** Variable name
*
* Return:
* Variable value
*/
export function nvim_get_vvar(denops: Denops, name: unknown): Promise<unknown>;
export function nvim_get_vvar(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_get_vvar", ...args);
}
/**
* Queues raw user-input. Unlike `nvim_feedkeys()`, this uses a low-level
* input buffer and the call is non-blocking (input is processed
* asynchronously by the eventloop).
*
* On execution error: does not fail, but updates v:errmsg.
*
* Note:
* `keycodes` like `<CR>` are translated, so `"<"` is special. To input a
* literal `"<"`, send `<LT>`.
*
* Note:
* For mouse events use `nvim_input_mouse()`. The pseudokey form
* `"<LeftMouse><col,row>"` is deprecated since `api-level` 6.
*
* Attributes:
* `api-fast`
*
* Parameters:
* - **{keys}** to be typed
*
* Return:
* Number of bytes actually written (can be fewer than requested if the
* buffer becomes full).
*/
export function nvim_input(denops: Denops, keys: unknown): Promise<unknown>;
export function nvim_input(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_input", ...args);
}
/**
* Send mouse event from GUI.
*
* Non-blocking: does not wait on any result, but queues the event to be
* processed soon by the event loop.
*
* Note:
* Currently this doesn't support "scripting" multiple mouse events by
* calling it multiple times in a loop: the intermediate mouse positions
* will be ignored. It should be used to implement real-time mouse input
* in a GUI. The deprecated pseudokey form (`"<LeftMouse><col,row>"`) of
* `nvim_input()` has the same limitation.
*
* Attributes:
* `api-fast`
*
* Parameters:
* - **{button}** Mouse button: one of "left", "right", "middle", "wheel",
* "move".
* - **{action}** For ordinary buttons, one of "press", "drag", "release".
* For the wheel, one of "up", "down", "left", "right".
* Ignored for "move".
* - **{modifier}** String of modifiers each represented by a single char. The
* same specifiers are used as for a key press, except that
* the "-" separator is optional, so "C-A-", "c-a" and "CA"
* can all be used to specify Ctrl+Alt+click.
* - **{grid}** Grid number if the client uses `ui-multigrid`, else 0.
* - **{row}** Mouse row-position (zero-based, like redraw events)
* - **{col}** Mouse column-position (zero-based, like redraw events)
*/
export function nvim_input_mouse(
denops: Denops,
button: unknown,
action: unknown,
modifier: unknown,
grid: unknown,
row: unknown,
col: unknown,
): Promise<unknown>;
export function nvim_input_mouse(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_input_mouse", ...args);
}
/**
* Gets the current list of buffer handles
*
* Includes unlisted (unloaded/deleted) buffers, like `:ls!`. Use
* `nvim_buf_is_loaded()` to check if a buffer is loaded.
*
* Return:
* List of buffer handles
*/
export function nvim_list_bufs(denops: Denops): Promise<unknown>;
export function nvim_list_bufs(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_list_bufs", ...args);
}
/**
* Get information about all open channels.
*
* Return:
* Array of Dictionaries, each describing a channel with the format
* specified at `nvim_get_chan_info()`.
*/
export function nvim_list_chans(denops: Denops): Promise<unknown>;
export function nvim_list_chans(
denops: Denops,
...args: unknown[]
): Promise<unknown> {
return denops.call("nvim_list_chans", ...args);
}
/**
* Gets the paths contained in 'runtimepath'.
*
* Return:
* List of paths
*/
export function nvim_list_runtime_paths(denops: Denops): Promise<unknown>;
export function nvim_list_runtime_paths(