任意logger?: Logger任意transport?: Transport保護_is保護client任意data保護prefix保護request保護transport静的 読み取り専用captureStaticcaptureすべてのエミッターに対するデフォルトの captureRejection 値を設定または取得します。
StaticdefaultStatic Readonlyerrorこのシンボルは、'error' イベントのみを監視するためのリスナーをインストールするために使用されます。このシンボルを使用してインストールされたリスナーは、通常の 'error' リスナーが呼び出される前に呼び出されます。
このシンボルを使用してリスナーをインストールしても、'error' イベントが発行された後の動作は変更されないため、通常の 'error' リスナーがインストールされていない場合、プロセスはクラッシュします。
nvim API 情報を取得します
現在のバッファを取得します
バッファハンドル
現在のバッファを設定します
開いているすべてのチャネルに関する情報を取得します
チャネルの配列
定義された色のマップを取得します
カラーマップ
バッファローカルの |user-commands| のマップを取得します。
グローバルな作業ディレクトリを変更します
ディレクトリパス
現在の行を取得します
現在の行の文字列
現在の行を設定します
行の内容
現在のモードを取得します。|mode()| の "blocking" は、Nvim が入力を待機している場合に true です。
モード情報
getNamespaces() のエイリアス
"runtimepath" に含まれるパスを取得します。
パスのリスト
ウィンドウのタブページを取得します
ウィンドウを含むタブページ
現在のタブページを設定します
アタッチされたUIを表す辞書のリストを取得します。
UI辞書の配列。各辞書には以下のキーがあります。"height"：UIの要求された高さ、"width"：UIの要求された幅、"rgb"：UIがrgbカラーを使用するかどうか（falseはctermカラーを意味します）、"ext_..."：要求されたUI拡張、|ui-options|を参照、"chan"：リモートUIのチャネルID（TUIには存在しません）
現在のウィンドウを取得します
ウィンドウハンドル
現在のウィンドウを設定します
ウィンドウハンドル
複数のAPIメソッドをアトミックに呼び出します。
これには主に2つの用途があります。
非同期コンテキストから、複数のリクエストをアトミックに実行するため。つまり、他のクライアントからの再描画、RPCリクエスト、またはユーザーインタラクションをインターリーブすることなく実行できます (ただし、APIメソッドは自動コマンドまたはイベント処理をトリガーする可能性があり、それらには副作用があります。例えば|:sleep|はタイマーを起動する可能性があります)。
多くのリクエストのシーケンスのRPCオーバーヘッド（ラウンドトリップ）を最小限に抑えるため。
新しい名前空間を作成するか、既存の名前空間を取得します。
名前空間は、バッファのハイライトと仮想テキストに使用されます。|nvim_buf_add_highlight()| と |nvim_buf_set_virtual_text()| を参照してください。
名前空間は、名前付きまたは匿名にできます。name が既存の名前空間と一致する場合、関連付けられたIDが返されます。name が空の文字列の場合、新しい匿名名前空間が作成されます。
名前空間名または空の文字列
名前空間ID
バッファがデタッチされるべき場合はtrueを返します
eventNameという名前のイベントに登録されたリスナーを、登録された順に同期的に呼び出し、それぞれのリスナーに指定された引数を渡します。
イベントにリスナーが存在する場合はtrueを返し、それ以外の場合はfalseを返します。
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Rest...args: any[]エミッターがリスナーを登録しているイベントのリストを配列で返します。配列の値は文字列またはSymbolです。
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
modeフラグによって制御されるさまざまな特性に従って、Nvimに入力キーを送信します。これは|nvim_input()|とは異なり、ブロッキング呼び出しです。
実行エラーが発生した場合：失敗しませんが、v:errmsgが更新されます。
入力するキー
動作フラグ。|feedkeys()|を参照してください。
trueの場合、keys内のK_SPECIAL/CSIバイトをエスケープします
EventEmitter の現在の最大リスナー値を返します。これは、emitter.setMaxListeners(n) によって設定されるか、defaultMaxListeners がデフォルトです。
生のユーザー入力をキューに入れます。|nvim_feedkeys()|とは異なり、これは低レベルの入力バッファを使用し、呼び出しはノンブロッキングです（入力はイベントループによって非同期に処理されます）。
実行エラーが発生した場合：失敗しませんが、v:errmsgが更新されます。
注意：次のような|keycodes|は
注意：マウスイベントの場合は、|nvim_input_mouse()|を使用してください。擬似キー形式「
入力するキー
GUIからマウスイベントを送信します。
この呼び出しはノンブロッキングです。結果として生じるアクションを待つのではなく、イベントをキューに入れてイベントループによってすぐに処理されるようにします。
注意：現在、これはループ内で複数回呼び出して複数のマウスイベントを「スクリプト化」することをサポートしていません。中間的なマウスの位置は無視されます。これはGUIでリアルタイムのマウス入力を実装するために使用する必要があります。非推奨の擬似キー形式（「
マウスボタン： "left"、"right"、"middle"、"wheel"のいずれか。
通常ボタンの場合は、"press"、"drag"、"release"のいずれか。ホイールの場合は、"up"、"down"、"left"、"right"のいずれか。
単一の文字で表される各修飾子の文字列。キープレスと同じ指定子が使用されますが、"-"セパレーターはオプションであるため、"C-A-"、"c-a"、"CA"のいずれもCtrl+Alt+クリックを指定するために使用できます。
クライアントが|ui-multigrid|を使用する場合はグリッド番号、それ以外の場合は0。
マウスの行位置（ゼロベース、再描画イベントと同様）
マウスの列位置（ゼロベース、再描画イベントと同様）
eventName という名前のイベントのリスナー配列の末尾に、listener 関数を追加します。listener が既に追加されているかのチェックは行われません。eventName と listener の同じ組み合わせを渡して複数回呼び出すと、listener が追加され、複数回呼び出されることになります。
server.on('connection', (stream) => {
console.log('someone connected!');
});
EventEmitter への参照を返します。これにより、呼び出しをチェーンできます。
デフォルトでは、イベントリスナーは追加された順序で呼び出されます。emitter.prependListener() メソッドを代わりに使用して、イベントリスナーをリスナー配列の先頭に追加できます。
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
イベントの名前。
コールバック関数
Rest...args: any[]eventName という名前のイベントに対して、一度だけ listener 関数を追加します。次に eventName がトリガーされると、このリスナーは削除されてから呼び出されます。
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
EventEmitter への参照を返します。これにより、呼び出しをチェーンできます。
デフォルトでは、イベントリスナーは追加された順序で呼び出されます。emitter.prependOnceListener() メソッドを代わりに使用して、イベントリスナーをリスナー配列の先頭に追加できます。
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
イベントの名前。
コールバック関数
Rest...args: any[]eventName という名前のイベントのリスナー配列の先頭に listener 関数を追加します。listener が既に追加されているかのチェックは行われません。eventName と listener の同じ組み合わせを渡して複数回呼び出すと、listener が追加され、複数回呼び出されることになります。
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
EventEmitter への参照を返します。これにより、呼び出しをチェーンできます。
イベントの名前。
コールバック関数
Rest...args: any[]eventName という名前のイベントに対して、リスナー配列の _先頭_ に 一度だけ listener 関数を追加します。次に eventName がトリガーされると、このリスナーは削除されてから呼び出されます。
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
EventEmitter への参照を返します。これにより、呼び出しをチェーンできます。
イベントの名前。
コールバック関数
Rest...args: any[]eventName という名前のイベントのリスナーの配列のコピーを返します。これには、.once() によって作成されたラッパーが含まれます。
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
指定されたeventNameのイベントリスナー配列から、指定されたlistenerを削除します。
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() は、リスナー配列から最大で1つのリスナーインスタンスを削除します。特定のeventNameのリスナー配列に同じリスナーが複数回追加されている場合、各インスタンスを削除するにはremoveListener()を複数回呼び出す必要があります。
イベントが発行されると、発行時にアタッチされていたすべてのリスナーが順番に呼び出されます。つまり、発行後かつ最後のリスナーの実行が完了する前にremoveListener()またはremoveAllListeners()を呼び出した場合、進行中のemit()からそれらを削除することはできません。後続のイベントは期待どおりに動作します。
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
リスナーは内部配列を使用して管理されるため、これを呼び出すと、削除されるリスナーの後に登録されたリスナーの配置インデックスが変更されます。これはリスナーが呼び出される順序には影響しませんが、emitter.listeners()メソッドによって返されるリスナー配列のコピーは再作成する必要があることを意味します。
単一の関数が単一のイベントのハンドラーとして複数回追加されている場合（以下の例のように）、removeListener()は最後に追加されたインスタンスを削除します。例では、once('ping')リスナーが削除されます。
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
EventEmitter への参照を返します。これにより、呼び出しをチェーンできます。
Rest...args: any[]補完ポップアップメニュー内のアイテムを選択します。
|ins-completion| がアクティブでない場合、このAPI呼び出しは黙って無視されます。|ui-popupmenu| を使用してマウスでポップアップメニューを制御する外部UIに役立ちます。マッピングでも使用できます。マッピングが補完モードを終了しないように、
選択する項目のインデックス（ゼロベース）。-1 の値は何も選択せず、元のテキストを復元します。
選択をバッファに挿入するかどうか。
補完を終了し、ポップアップメニューを閉じます。insertを意味します。
オプションのパラメータ。将来の使用のために予約されています。
現在のウィンドウを設定します
ウィンドウハンドル
winClose のパブリックエイリアス
winConfigの公開エイリアス
StaticgeteventName という名前のイベントのリスナーの配列のコピーを返します。
EventEmitterの場合、これはemitterで.listenersを呼び出すのと全く同じ動作をします。
EventTargetの場合、これはイベントターゲットのイベントリスナーを取得する唯一の方法です。これはデバッグや診断の目的で役立ちます。
const { getEventListeners, EventEmitter } = require('events');
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
getEventListeners(ee, 'foo'); // [listener]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
getEventListeners(et, 'foo'); // [listener]
}
Staticlistener指定されたemitterに登録されている指定されたeventNameのリスナー数を返すクラスメソッド。
const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
クエリを実行するemitter
イベント名
Staticonconst { on, EventEmitter } = require('events');
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
eventNameイベントを反復処理するAsyncIteratorを返します。EventEmitterが'error'を発行するとスローします。ループを終了すると、すべてのリスナーが削除されます。各反復処理で返されるvalueは、発行されたイベント引数で構成される配列です。
AbortSignalを使用して、イベントの待機をキャンセルできます。
const { on, EventEmitter } = require('events');
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
リッスンしているイベントの名前
Optionaloptions: StaticEventEmitterOptionsemitterによって発行されたeventNameイベントを反復処理します
StaticonceEventEmitterが指定されたイベントを発行したときに履行されるPromise、または待機中にEventEmitterが'error'を発行した場合に拒否されるPromiseを作成します。Promiseは、指定されたイベントに発行されたすべての引数の配列で解決されます。
このメソッドは意図的に汎用的であり、特別な'error'イベントセマンティクスを持たず、'error'イベントをリッスンしないWebプラットフォームのEventTargetインターフェースで動作します。
const { once, EventEmitter } = require('events');
async function run() {
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.log('error happened', err);
}
}
run();
'error'イベントの特別な処理は、別のイベントを待機するためにevents.once()を使用する場合にのみ使用されます。events.once()を'error'イベント自体を待機するために使用する場合、特別な処理なしで他の種類のイベントとして扱われます
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.log('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
AbortSignalを使用して、イベントの待機をキャンセルできます
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
Optionaloptions: StaticEventEmitterOptionsOptionaloptions: StaticEventEmitterOptions
Neovim API