Skip to content

Commit 1f1f09d

Browse files
committed
Update channel.{txt,jax}
1 parent d84aed2 commit 1f1f09d

File tree

2 files changed

+100
-22
lines changed

2 files changed

+100
-22
lines changed

doc/channel.jax

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*channel.txt* For Vim バージョン 9.1. Last change: 2023 Aug 15
1+
*channel.txt* For Vim バージョン 9.1. Last change: 2024 Jun 06
22

33

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

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

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

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

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

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

523529

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

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

546554

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

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

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

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

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

578590
|method| としても使用できる: >
579591
GetChannel()->ch_getjob()
580-
592+
<
593+
戻り値の型: |job| または |String|
581594

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

613626
|method| としても使用できる: >
614627
GetChannel()->ch_info()
615-
628+
<
629+
戻り値の型: dict<any>
616630

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

628642
|method| としても使用できる: >
629643
'did something'->ch_log()
630-
644+
<
645+
戻り値の型: dict<any>
631646

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

656671
|method| としても使用できる: >
657672
'logfile'->ch_logfile('w')
658-
673+
<
674+
戻り値の型: |Number|
659675

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

671687
|method| としても使用できる: >
672688
GetAddress()->ch_open()
673-
689+
<
690+
戻り値の型: |channel|
674691

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

682699
|method| としても使用できる: >
683700
GetChannel()->ch_read()
684-
701+
<
702+
戻り値の型: |String|
685703

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

691709
|method| としても使用できる: >
692710
GetChannel()->ch_readblob()
693-
711+
<
712+
戻り値の型: |Blob|
694713

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

701720
|method| としても使用できる: >
702721
GetChannel()->ch_readraw()
703-
722+
<
723+
戻り値の型: |String|
704724

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

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

726748

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

735757
|method| としても使用できる: >
736758
GetChannel()->ch_sendraw(rawexpr)
737-
759+
<
760+
戻り値の型: dict<any> または |String|
738761

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

753776
|method| としても使用できる: >
754777
GetChannel()->ch_setoptions(options)
755-
778+
<
779+
戻り値の型: |Number|
756780

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

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

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

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

936967

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

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

945978

946979
job_start({command} [, {options}]) *job_start()*
@@ -1003,6 +1036,8 @@ job_start({command} [, {options}]) *job_start()*
10031036

10041037
|method| としても使用できる: >
10051038
BuildCommand()->job_start()
1039+
<
1040+
戻り値の型: |Number|
10061041

10071042

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

10261061
|method| としても使用できる: >
10271062
GetJob()->job_status()
1063+
<
1064+
戻り値の型: |job|
10281065

10291066

10301067
job_stop({job} [, {how}]) *job_stop()*
@@ -1069,6 +1106,8 @@ job_stop({job} [, {how}]) *job_stop()*
10691106

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

10731112

10741113
==============================================================================

0 commit comments

Comments
 (0)