Skip to content

Update channel.{txt,jax} #1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 15, 2024
Merged

Update channel.{txt,jax} #1564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f1f09d
Update channel.{txt,jax}
h-east Jun 9, 2024
2343d73
Fix by review
h-east Jun 10, 2024
6bd5646
Follow the update original
h-east Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 50 additions & 11 deletions doc/channel.jax
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*channel.txt* For Vim バージョン 9.1. Last change: 2023 Aug 15
*channel.txt* For Vim バージョン 9.1. Last change: 2024 Jun 13


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -503,6 +503,8 @@ ch_canread({handle}) *ch_canread()*

|method| としても使用できる: >
GetChannel()->ch_canread()
<
戻り値の型: |Number|

ch_close({handle}) *ch_close()*
{handle} を閉じる。|channel-close| を参照。
Expand All @@ -511,6 +513,8 @@ ch_close({handle}) *ch_close()*

|method| としても使用できる: >
GetChannel()->ch_close()
<
戻り値の型: |Number|

ch_close_in({handle}) *ch_close_in()*
{handle} の "入力" を閉じる。|channel-close-in| を参照。
Expand All @@ -519,6 +523,8 @@ ch_close_in({handle}) *ch_close_in()*

|method| としても使用できる: >
GetChannel()->ch_close_in()
<
戻り値の型: |Number|


ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*
Expand All @@ -542,6 +548,8 @@ ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*

|method| としても使用できる: >
GetChannel()->ch_evalexpr(expr)
<
戻り値の型: dict<any> または |String|


ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
Expand All @@ -559,6 +567,8 @@ ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*

|method| としても使用できる: >
GetChannel()->ch_evalraw(rawstring)
<
戻り値の型: dict<any> または |String|

ch_getbufnr({handle}, {what}) *ch_getbufnr()*
文字列 {what} に使用されている {handle} のバッファ番号を得る。
Expand All @@ -569,6 +579,8 @@ ch_getbufnr({handle}, {what}) *ch_getbufnr()*

|method| としても使用できる: >
GetChannel()->ch_getbufnr(what)
<
戻り値の型: |Number|

ch_getjob({channel}) *ch_getjob()*
{channel} に関連付けられた Job を得る。
Expand All @@ -577,7 +589,8 @@ ch_getjob({channel}) *ch_getjob()*

|method| としても使用できる: >
GetChannel()->ch_getjob()

<
戻り値の型: |job| または |String|

ch_info({handle}) *ch_info()*
{handle} に関する情報を辞書で返す。アイテムは:
Expand Down Expand Up @@ -612,7 +625,8 @@ ch_info({handle}) *ch_info()*

|method| としても使用できる: >
GetChannel()->ch_info()

<
戻り値の型: dict<any>

ch_log({msg} [, {handle}]) *ch_log()*
|ch_logfile()| によってログファイルが開かれている場合はチャネ
Expand All @@ -627,7 +641,8 @@ ch_log({msg} [, {handle}]) *ch_log()*

|method| としても使用できる: >
'did something'->ch_log()

<
戻り値の型: dict<any>

ch_logfile({fname} [, {mode}]) *ch_logfile()*
{fname} へチャネルの挙動ログ出力を開始する。
Expand Down Expand Up @@ -655,7 +670,8 @@ ch_logfile({fname} [, {mode}]) *ch_logfile()*

|method| としても使用できる: >
'logfile'->ch_logfile('w')

<
戻り値の型: |Number|

ch_open({address} [, {options}]) *ch_open()*
{address}へのチャネルを開く。|channel|を参照。
Expand All @@ -670,7 +686,8 @@ ch_open({address} [, {options}]) *ch_open()*

|method| としても使用できる: >
GetAddress()->ch_open()

<
戻り値の型: |channel|

ch_read({handle} [, {options}]) *ch_read()*
{handle} から読み込みメッセージを受信する。
Expand All @@ -681,7 +698,8 @@ ch_read({handle} [, {options}]) *ch_read()*

|method| としても使用できる: >
GetChannel()->ch_read()

<
戻り値の型: |String|

ch_readblob({handle} [, {options}]) *ch_readblob()*
ch_read() と同様に動作するが、バイナリデータを読み込んで
Expand All @@ -690,7 +708,8 @@ ch_readblob({handle} [, {options}]) *ch_readblob()*

|method| としても使用できる: >
GetChannel()->ch_readblob()

<
戻り値の型: |Blob|

ch_readraw({handle} [, {options}]) *ch_readraw()*
ch_read() と同様に動作するが JS や JSON の場合でもメッセージは
Expand All @@ -700,7 +719,8 @@ ch_readraw({handle} [, {options}]) *ch_readraw()*

|method| としても使用できる: >
GetChannel()->ch_readraw()

<
戻り値の型: |String|

ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
{handle} へ {expr} を送信する。{expr} はチャネル側と同じ型にエ
Expand All @@ -722,6 +742,8 @@ ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*

|method| としても使用できる: >
GetChannel()->ch_sendexpr(expr)
<
戻り値の型: dict<any> または |String|


ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()*
Expand All @@ -734,7 +756,8 @@ ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()*

|method| としても使用できる: >
GetChannel()->ch_sendraw(rawexpr)

<
戻り値の型: dict<any> または |String|

ch_setoptions({handle}, {options}) *ch_setoptions()*
{handle} にオプションを設定する:
Expand All @@ -752,7 +775,8 @@ ch_setoptions({handle}, {options}) *ch_setoptions()*

|method| としても使用できる: >
GetChannel()->ch_setoptions(options)

<
戻り値の型: |Number|

ch_status({handle} [, {options}]) *ch_status()*
{handle} の状態を返す:
Expand All @@ -772,6 +796,8 @@ ch_status({handle} [, {options}]) *ch_status()*
<
|method| としても使用できる: >
GetChannel()->ch_status()
<
戻り値の型: |String|

==============================================================================
9. チャネルでジョブを開始する *job-start* *job*
Expand Down Expand Up @@ -904,6 +930,8 @@ job_getchannel({job}) *job_getchannel()*
<
|method| としても使用できる: >
GetJob()->job_getchannel()
<
戻り値の型: |channel|

job_info([{job}]) *job_info()*
{job}に関する情報を持つ辞書を返す:
Expand Down Expand Up @@ -932,6 +960,9 @@ job_info([{job}]) *job_info()*

|method| としても使用できる: >
GetJob()->job_info()
<
戻り値の型: {job} が指定されたかどうかによって、dict<any> また
は list<job>


job_setoptions({job}, {options}) *job_setoptions()*
Expand All @@ -941,6 +972,8 @@ job_setoptions({job}, {options}) *job_setoptions()*

|method| としても使用できる: >
GetJob()->job_setoptions(options)
<
戻り値の型: |Number|


job_start({command} [, {options}]) *job_start()*
Expand Down Expand Up @@ -1003,6 +1036,8 @@ job_start({command} [, {options}]) *job_start()*

|method| としても使用できる: >
BuildCommand()->job_start()
<
戻り値の型: |job|


job_status({job}) *job_status()* *E916*
Expand All @@ -1025,6 +1060,8 @@ job_status({job}) *job_status()* *E916*

|method| としても使用できる: >
GetJob()->job_status()
<
戻り値の型: |String|


job_stop({job} [, {how}]) *job_stop()*
Expand Down Expand Up @@ -1069,6 +1106,8 @@ job_stop({job} [, {how}]) *job_stop()*

|method| としても使用できる: >
GetJob()->job_stop()
<
戻り値の型: |Number|


==============================================================================
Expand Down
Loading