Skip to main content
Module

x/denops_std/function/nvim/mod.ts>nvim_get_chan_info

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

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()`.

Parameters

denops: Denops
chan: unknown

Returns

Promise<unknown>