Bluetooth Pub-Sub 用の高レベルのクロスプラットフォーム API
Bluetooth
( EventEmitter
拡張)Bluetooth サービスのインスタンスを作成します。
constructor(serviceId)
コンストラクターは、 true
に設定されたプロパティの例です。 キーと値のペアを使用して新しいサービスを作成します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
サービスID | 弦 | 間違い | タイプを決定するためのデフォルト値が与えられる |
start()
Bluetoothサービスを開始します。
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ipc.Result> |
subscribe(id )
既知の UUID に対応する公開された値のスキャンを開始します。 UUID をサブスクライブすると、その UUID に対応するイベントが発行されます。これらのイベントを受信するには、次のようにイベント リスナーを追加します。
const ble = new Bluetooth ( id )
ble . subscribe ( uuid )
ble . on ( uuid , ( data , details ) => {
// ...do something interesting
} )
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ID | 弦 | 間違い | 既知の UUID |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ipc.Result> |
publish(id, value)
既知の UUID の新しい値のアドバタイズを開始する
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ID | 弦 | 間違い | 既知の UUID | |
価値 | 弦 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
外部ドキュメント: https://nodejs.org/api/buffer.html#buffer_class_buffer
ブラウザー用の、node.js のバッファー モジュール。
Buffer.TYPED_ARRAY_SUPPORT
の場合: === true Uint8Array 実装を使用 (最速) === false 警告を出力し、オブジェクト実装 (最も互換性があり、IE6 も含む) を持つbuffer
v4.x の使用を推奨します。
型付き配列をサポートするブラウザは、IE 10 以降、Firefox 4 以降、Chrome 7 以降、Safari 5.1 以降、Opera 11.6 以降、iOS 4.2 以降です。
proto を使用してサブクラス化できない場合、ブラウザは型付き配列をサポートしないことを報告します。 Firefox 4-29 には、 Uint8Array
への新しいプロパティの追加のサポートがありません (参照: https://bugzilla.mozilla.org/show_bug.cgi?id=695438)。 IE 10 にはprotoのサポートがなく、バグのある型付き配列の実装があります。
Buffer.TYPED_ARRAY_SUPPORT
の場合: === true Uint8Array 実装を使用 (最速) === false 警告を出力し、オブジェクト実装 (最も互換性があり、IE6 も含む) を持つbuffer
v4.x の使用を推奨します。
型付き配列をサポートするブラウザは、IE 10 以降、Firefox 4 以降、Chrome 7 以降、Safari 5.1 以降、Opera 11.6 以降、iOS 4.2 以降です。
proto を使用してサブクラス化できない場合、ブラウザは型付き配列をサポートしないことを報告します。 Firefox 4-29 には、 Uint8Array
への新しいプロパティの追加のサポートがありません (参照: https://bugzilla.mozilla.org/show_bug.cgi?id=695438)。 IE 10 にはprotoのサポートがなく、バグのある型付き配列の実装があります。
Buffer.TYPED_ARRAY_SUPPORT
の場合: === true Uint8Array 実装を使用 (最速) === false 警告を出力し、オブジェクト実装 (最も互換性があり、IE6 も含む) を持つbuffer
v4.x の使用を推奨します。
型付き配列をサポートするブラウザは、IE 10 以降、Firefox 4 以降、Chrome 7 以降、Safari 5.1 以降、Opera 11.6 以降、iOS 4.2 以降です。
proto を使用してサブクラス化できない場合、ブラウザは型付き配列をサポートしないことを報告します。 Firefox 4-29 には、 Uint8Array
への新しいプロパティの追加のサポートがありません (参照: https://bugzilla.mozilla.org/show_bug.cgi?id=695438)。 IE 10 にはprotoのサポートがなく、バグのある型付き配列の実装があります。
Buffer.TYPED_ARRAY_SUPPORT
の場合: === true Uint8Array 実装を使用 (最速) === false 警告を出力し、オブジェクト実装 (最も互換性があり、IE6 も含む) を持つbuffer
v4.x の使用を推奨します。
型付き配列をサポートするブラウザは、IE 10 以降、Firefox 4 以降、Chrome 7 以降、Safari 5.1 以降、Opera 11.6 以降、iOS 4.2 以降です。
proto を使用してサブクラス化できない場合、ブラウザは型付き配列をサポートしないことを報告します。 Firefox 4-29 には、 Uint8Array
への新しいプロパティの追加のサポートがありません (参照: https://bugzilla.mozilla.org/show_bug.cgi?id=695438)。 IE 10 にはprotoのサポートがなく、バグのある型付き配列の実装があります。
Buffer コンストラクターは、プロトタイプがBuffer.prototype
に変更されたUint8Array
のインスタンスを返します。さらに、 Buffer
Uint8Array
のサブクラスであるため、返されるインスタンスにはすべてのノードBuffer
メソッドとUint8Array
メソッドが含まれます。角括弧表記は期待どおりに機能し、単一のオクテットを返します。
Uint8Array
プロトタイプは変更されていません。
機能的には Buffer(arg, encoding) と同等ですが、値が数値の場合は TypeError をスローします。 Buffer.from(str[, エンコーディング]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
機能的には Buffer(arg, encoding) と同等ですが、値が数値の場合は TypeError をスローします。 Buffer.from(str[, エンコーディング]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
機能的には Buffer(arg, encoding) と同等ですが、値が数値の場合は TypeError をスローします。 Buffer.from(str[, エンコーディング]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
機能的には Buffer(arg, encoding) と同等ですが、値が数値の場合は TypeError をスローします。 Buffer.from(str[, エンコーディング]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
新しい満たされた Buffer インスタンスを作成します。 alloc(サイズ[, フィル[, エンコーディング]])
新しい満たされた Buffer インスタンスを作成します。 alloc(サイズ[, フィル[, エンコーディング]])
新しい満たされた Buffer インスタンスを作成します。 alloc(サイズ[, フィル[, エンコーディング]])
新しい満たされた Buffer インスタンスを作成します。 alloc(サイズ[, フィル[, エンコーディング]])
Buffer(num) と同等で、デフォルトではゼロ以外が埋め込まれた Buffer インスタンスを作成します。
Buffer(num) と同等で、デフォルトではゼロが埋め込まれていない Buffer インスタンスを作成します。
Buffer(num) と同等で、デフォルトではゼロが埋め込まれていない Buffer インスタンスを作成します。
Buffer(num) と同等で、デフォルトではゼロが埋め込まれていない Buffer インスタンスを作成します。
SlowBuffer(num) と同等で、デフォルトではゼロ以外が埋め込まれた Buffer インスタンスを作成します。
SlowBuffer(num) と同等で、デフォルトではゼロ以外が埋め込まれた Buffer インスタンスを作成します。
SlowBuffer(num) と同等で、デフォルトではゼロ以外のバッファ インスタンスが作成されます。
SlowBuffer(num) と同等で、デフォルトではゼロ以外が埋め込まれた Buffer インスタンスを作成します。
ランダムなバイトとハッシュを取得するための、 crypto.subtle
API に関するいくつかの高レベルのメソッド。
ウェブ暗号化 API
getRandomValues(buffer)
外部ドキュメント: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
暗号的に強力なランダム値をbuffer
に生成します
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
バッファ | 型付き配列 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 型付き配列 |
ページごとのランダムバイトの最大合計サイズ
ランダムバイトの最大合計サイズ。
ページごとに割り当てられるバイトの最大合計量 (最大/クォータ)
randomBytes(size)
size
ランダムなバイトを生成します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
サイズ | 番号 | 間違い | 生成するバイト数。サイズは 2**31 - 1 を超えてはなりません。 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | バッファ | ランダムなバイトを含むsocket.Bufferのインスタンスで解決するPromise。 |
createDigest(algorithm, message)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
アルゴリズム | 弦 | 間違い | SHA-1 | |
メッセージ | バッファ |型付き配列 |データビュー | 間違い | socket.Buffer、TypedArray、または Dataview のインスタンス。 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 | ハッシュを使用してsocket.Bufferのインスタンスで解決するPromise。 |
このモジュールは、UDP データグラム ソケットの実装を提供します。マルチキャストのメソッドやプロパティは(まだ)提供されていません。
ERR_SOCKET_ALREADY_BOUND
( SocketError
を拡張)ソケットがすでにバインドされている場合にスローされます。
ERR_SOCKET_DGRAM_IS_CONNECTED
( SocketError
拡張)ソケットがすでに接続されている場合にスローされます。
ERR_SOCKET_DGRAM_NOT_CONNECTED
( SocketError
拡張)ソケットが接続されていない場合にスローされます。
ERR_SOCKET_DGRAM_NOT_RUNNING
( SocketError
を拡張)ソケットが実行されていない (バインドまたは接続されていない) 場合にスローされます。
ERR_SOCKET_BAD_TYPE
( TypeError
拡張)引数で不正なソケット タイプが使用されている場合にスローされます。
ERR_SOCKET_BAD_PORT
( RangeError
拡張)不正なポートが指定された場合にスローされます。
createSocket(options, callback)
Socket
インスタンスを作成します。もし ()
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
オプション | 文字列 |物体 | 間違い | 文字列 ('udp4' または 'udp6') またはオプション オブジェクトのいずれか | |
オプション.タイプ | 弦 | 真実 | ソケットのファミリー。 「udp4」または「udp6」のいずれかである必要があります。必須。 | |
options.reuseAddr | ブール値 | 間違い | 真実 | true の場合、socket.bind() は、別のプロセスがすでにソケットをバインドしている場合でも、そのアドレスを再利用します。デフォルト: false。 |
options.ipv6Only | ブール値 | 間違い | 真実 | ipv6Only を true に設定すると、デュアルスタックのサポートが無効になります。つまり、アドレス :: にバインドしても 0.0.0.0 はバインドされません。デフォルト: false。 |
options.recvBufferSize | 番号 | 真実 | SO_RCVBUF ソケット値を設定します。 | |
options.sendBufferSize | 番号 | 真実 | SO_SNDBUF ソケット値を設定します。 | |
オプション.シグナル | アボートシグナル | 真実 | ソケットを閉じるために使用できる AbortSignal。 | |
折り返し電話 | 関数 | 真実 | 「メッセージ」イベントのリスナーとしてアタッチされます。オプション。 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | ソケット |
Socket
( EventEmitter
拡張)dgram.Socket の新しいインスタンスは、dgram.createSocket() を使用して作成されます。 new キーワードは、dgram.Socket インスタンスの作成には使用できません。
bind(port, address, callback)
外部ドキュメント: https://nodejs.org/api/dgram.html#socketbindport-address-callback
名前付きポートとオプションのアドレスでデータグラム メッセージをリッスンする アドレスが指定されていない場合、オペレーティング システムはすべてのアドレスでリッスンしようとします。バインドが完了すると、「listening」イベントが発行され、オプションのコールバック関数が呼び出されます。
バインディングが失敗すると、「エラー」イベントが生成されます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ポート | 番号 | 間違い | メッセージをリッスンするポート | |
住所 | 弦 | 間違い | バインド先のアドレス (0.0.0.0) | |
折り返し電話 | 関数 | 間違い | パラメータなし。バインディングが完了すると呼び出されます。 |
connect(port, host, connectListener)
外部ドキュメント: https://nodejs.org/api/dgram.html#socketconnectport-address-callback
dgram.Socket をリモート アドレスとポートに関連付けます。このハンドルによって送信されるすべてのメッセージは、その宛先に自動的に送信されます。また、ソケットはそのリモート ピアからのメッセージのみを受信します。すでに接続されているソケットで connect() を呼び出そうとすると、ERR_SOCKET_DGRAM_IS_CONNECTED 例外が発生します。アドレスが指定されていない場合は、デフォルトで「127.0.0.1」(udp4 ソケットの場合) または「::1」(udp6 ソケットの場合) が使用されます。接続が完了すると、「connect」イベントが発行され、オプションのコールバック関数が呼び出されます。失敗した場合はコールバックが呼び出されるか、これに失敗した場合は「エラー」イベントが生成されます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ポート | 番号 | 間違い | クライアントが接続するポート。 | |
ホスト | 弦 | 真実 | クライアントが接続するホスト。 | |
コネクトリスナー | 関数 | 真実 | socket.connect()メソッドの共通パラメータ。 「connect」イベントのリスナーとして一度追加されます。 |
disconnect()
外部ドキュメント: https://nodejs.org/api/dgram.html#socketdisconnect
接続された dgram.Socket とそのリモート アドレスの関連付けを解除する同期関数。バインドされていないソケット、またはすでに切断されているソケットでdisconnect()を呼び出そうとすると、ERR_SOCKET_DGRAM_NOT_CONNECTED例外が発生します。
send(msg, offset, length, port, address, callback)
外部ドキュメント: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback
ソケット上でデータグラムをブロードキャストします。コネクションレス型ソケットの場合は、宛先ポートとアドレスを指定する必要があります。一方、接続されたソケットは、関連付けられたリモート エンドポイントを使用するため、ポートとアドレスの引数を設定する必要はありません。
msg 引数には、送信するメッセージが含まれます。そのタイプに応じて、異なる動作が適用される場合があります。 msg が Buffer、TypedArray、または DataView の場合、オフセットと長さは、それぞれメッセージが始まるバッファ内のオフセットとメッセージ内のバイト数を指定します。 msg が文字列の場合、「utf8」エンコーディングのバッファに自動的に変換されます。マルチバイト文字を含むメッセージの場合、オフセットと長さは文字の位置ではなくバイト長に基づいて計算されます。 msg が配列の場合、オフセットと長さを指定してはなりません。
address 引数は文字列です。 address の値がホスト名の場合、ホストのアドレスを解決するために DNS が使用されます。アドレスが指定されていない場合、または null の場合は、「127.0.0.1」(udp4 ソケットの場合) または「::1」(udp6 ソケットの場合) がデフォルトで使用されます。
ソケットが以前にバインド呼び出しでバインドされていない場合、ソケットにはランダムなポート番号が割り当てられ、「すべてのインターフェイス」アドレス (udp4 ソケットの場合は「0.0.0.0」、udp6 ソケットの場合は「::0」) にバインドされます。 。)
DNS エラーを報告する方法として、または buf オブジェクトをいつ再利用しても安全かを判断する方法として、オプションのコールバック関数を指定できます。 DNS ルックアップは、Node.js イベント ループの少なくとも 1 ティックの間、送信時間を遅らせます。
データグラムが送信されたことを確実に知る唯一の方法は、コールバックを使用することです。エラーが発生してコールバックが指定された場合、エラーは最初の引数としてコールバックに渡されます。コールバックが指定されていない場合、エラーはソケット オブジェクトの「エラー」イベントとして発行されます。
オフセットと長さはオプションですが、どちらかを使用する場合は両方とも設定する必要があります。これらは、最初の引数が Buffer、TypedArray、または DataView である場合にのみサポートされます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
メッセージ | バッファ |型付き配列 |データビュー |文字列 |配列 | 間違い | 送信されるメッセージ。 | |
オフセット | 整数 | 真実 | メッセージが開始されるバッファ内のオフセット。 | |
長さ | 整数 | 真実 | メッセージ内のバイト数。 | |
ポート | 整数 | 真実 | 宛先ポート。 | |
住所 | 弦 | 真実 | 宛先のホスト名または IP アドレス。 | |
折り返し電話 | 関数 | 真実 | メッセージが送信されたときに呼び出されます。 |
close(callback)
外部ドキュメント: https://nodejs.org/api/dgram.html#socketclosecallback
基礎となるソケットを閉じて、そのソケットでのデータの待機を停止します。コールバックが提供される場合、それは「close」イベントのリスナーとして追加されます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
折り返し電話 | 関数 | 真実 | 接続が完了したとき、またはエラーが発生したときに呼び出されます。 |
address()
外部ドキュメント: https://nodejs.org/api/dgram.html#socketaddress
ソケットのアドレス情報を含むオブジェクトを返します。 UDP ソケットの場合、このオブジェクトにはアドレス、ファミリー、およびポートのプロパティが含まれます。
このメソッドは、バインドされていないソケットで呼び出された場合、EBADF をスローします。
戻り値 | タイプ | 説明 |
---|---|---|
ソケット情報 | 物体 | ローカルソケットに関する情報 |
ソケット情報アドレス | 弦 | ソケットのIPアドレス |
ソケット情報.ポート | 弦 | ソケットのポート |
ソケット情報ファミリー | 弦 | ソケットの IP ファミリ |
remoteAddress()
外部ドキュメント: https://nodejs.org/api/dgram.html#socketremoteaddress
リモート エンドポイントのアドレス、ファミリー、ポートを含むオブジェクトを返します。ソケットが接続されていない場合、このメソッドは ERR_SOCKET_DGRAM_NOT_CONNECTED 例外をスローします。
戻り値 | タイプ | 説明 |
---|---|---|
ソケット情報 | 物体 | リモートソケットに関する情報 |
ソケット情報アドレス | 弦 | ソケットのIPアドレス |
ソケット情報.ポート | 弦 | ソケットのポート |
ソケット情報ファミリー | 弦 | ソケットの IP ファミリ |
setRecvBufferSize(size)
外部ドキュメント: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize
SO_RCVBUF ソケット オプションを設定します。ソケット受信バッファの最大値をバイト単位で設定します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
サイズ | 番号 | 間違い | 新しい受信バッファのサイズ |
setSendBufferSize(size)
外部ドキュメント: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize
SO_SNDBUF ソケット オプションを設定します。ソケット送信バッファの最大値をバイト単位で設定します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
サイズ | 番号 | 間違い | 新しい送信バッファのサイズ |
getRecvBufferSize()
外部ドキュメント: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize
getSendBufferSize()
外部ドキュメント: https://nodejs.org/api/dgram.html#socketgetsendbuffersize
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 番号 | SO_SNDBUF ソケット送信バッファ サイズ (バイト単位)。 |
このモジュールにより名前解決が可能になります。たとえば、ホスト名の IP アドレスを検索するために使用します。ドメイン ネーム システム (DNS) にちなんで名付けられていますが、検索に常に DNS プロトコルを使用するとは限りません。 dns.lookup() は、オペレーティング システムの機能を使用して名前解決を実行します。ネットワーク通信を実行する必要がない場合もあります。同じシステム上の他のアプリケーションと同じ方法で名前解決を実行するには、dns.lookup() を使用します。
lookup(hostname, opts, cb)
外部ドキュメント: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback
ホスト名 (例: example.org
) を最初に見つかった A (IPv4) または AAAA (IPv6) レコードに解決します。すべてのオプションのプロパティはオプションです。オプションが整数の場合、それは 4 または 6 である必要があります。オプションが 0 であるか指定されていない場合は、IPv4 アドレスと IPv6 アドレスの両方が見つかった場合に返されます。
Node.js Web サイトから...
all オプションを true に設定すると、コールバックの引数は (err, address) に変更され、アドレスはプロパティ address と family を持つオブジェクトの配列になります。
エラーの場合、err は Error オブジェクトで、err.code はエラー コードです。 err.code は、ホスト名が存在しない場合だけでなく、使用可能なファイル記述子がないなどの他の方法で検索が失敗した場合にも「ENOTFOUND」に設定されることに注意してください。 dns.lookup() は、必ずしも DNS プロトコルと関係があるわけではありません。この実装では、名前とアドレスを関連付けたり、その逆を実行したりできるオペレーティング システム機能を使用します。この実装は、Node.js プログラムの動作に微妙だが重要な影響を与える可能性があります。 dns.lookup() を使用する前に、時間をかけて「実装に関する考慮事項」セクションを参照してください。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ホスト名 | 弦 | 間違い | 解決するホスト名。 | |
選択します | 物体 | 真実 | オプションオブジェクト。 | |
オプトファミリー | 番号 |弦 | 0 | 間違い | レコードファミリー。 4、6、または 0 である必要があります。下位互換性の理由から、「IPv4」と「IPv6」はそれぞれ 4 と 6 として解釈されます。値 0 は、IPv4 アドレスと IPv6 アドレスの両方が返されることを示します。デフォルト: 0。 |
CB | 関数 | 間違い | メソッドの完了後に呼び出す関数。 |
このモジュールにより名前解決が可能になります。たとえば、ホスト名の IP アドレスを検索するために使用します。ドメイン ネーム システム (DNS) にちなんで名付けられていますが、検索に常に DNS プロトコルを使用するとは限りません。 dns.lookup() は、オペレーティング システムの機能を使用して名前解決を実行します。ネットワーク通信を実行する必要がない場合があります。同じシステム上の他のアプリケーションと同じ方法で名前解決を実行するには、dns.lookup() を使用します。
lookup(hostname, opts)
外部ドキュメント: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ホスト名 | 弦 | 間違い | 解決するホスト名。 | |
選択します | 物体 | 真実 | オプションオブジェクト。 | |
オプトファミリー | 番号 |弦 | 0 | 間違い | レコードファミリー。 4、6、または 0 である必要があります。下位互換性の理由から、「IPv4」と「IPv6」はそれぞれ 4 と 6 として解釈されます。値 0 は、IPv4 アドレスと IPv6 アドレスの両方が返されることを示します。デフォルト: 0。 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
このモジュールにより、標準の POSIX 機能をモデルにした方法でファイル システムと対話できるようになります。
アプリケーション サンドボックスは、ファイル システムへのアクセスを制限します。詳細については、アプリケーション サンドボックスのドキュメントを参照してください: https://sockets.sh/guides/#working-with-the-file-system-on-ios
Promise ベースの API を使用するには:
import * as fs from '@socketsupply/socket-api/fs/promises.js' ;
コールバック API と非同期 API を使用するには:
import * as fs from '@socketsupply/socket-api/fs/index.js' ;
access(path, mode , callback)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsopenpath-flags-mode-callback
成功またはエラー時にcallback
を呼び出す特定のモードのファイルへのアクセスを非同期的にチェックします。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
モード | 弦 | F_OK(0) | 真実 | |
折り返し電話 | 関数(エラー、FD) | 間違い |
chmod(path, mode, callback)
外部ドキュメント: https://nodejs.org/api/fs.html#fschmodpath-mode-callback
ファイルの権限を非同期的に変更します。完了コールバックには、考えられる例外以外の引数は与えられません。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
モード | 番号 | 間違い | ||
折り返し電話 | 関数(エラー) | 間違い |
close(fd, callback)
成功またはエラー時にcallback
を呼び出すファイル記述子を非同期的に閉じます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
fd | 番号 | 間違い | ||
折り返し電話 | 関数(エラー) | 真実 |
copyFile()
これはfs/index.js
内のcopyFile
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
createReadStream(path, options)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | fs.ReadStream |
createWriteStream(path, options)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | fs.WriteStream |
fstat(fd, options, callback)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback
ファイル記述子の <fs.Stats> を使用してコールバックを呼び出します。詳細については、POSIX fstat(2) ドキュメントを参照してください。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
fd | 番号 | 間違い | ファイル記述子。 | |
オプション | 物体 | 真実 | オプションオブジェクト。 | |
折り返し電話 | 関数 | 間違い | 完了後に呼び出す関数。 |
open(path, flags , mode , callback)
成功またはエラー時にcallback
を呼び出すファイルを非同期的に開きます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
フラグ | 弦 | r | 真実 | |
モード | 弦 | 0o666 | 真実 | |
折り返し電話 | 関数(エラー、FD) | 間違い |
opendir(path, options, callback)
成功またはエラー時にcallback
を呼び出すディレクトリを非同期的に開きます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
options.withFileTypes | ブール値 | 間違い | 真実 | |
折り返し電話 | 関数(エラー、FD) | 間違い |
read(fd, buffer, offset, length, position, callback)
開いているファイル記述子から非同期的に読み取ります。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
fd | 番号 | 間違い | ||
バッファ | オブジェクト |バッファ |型付き配列 | 間違い | データが書き込まれるバッファー。 | |
オフセット | 番号 | 間違い | データを書き込むバッファ内の位置。 | |
長さ | 番号 | 間違い | 読み取るバイト数。 | |
位置 | 番号 |ビッグイント |ヌル | 間違い | ファイル内のどこから読み取りを開始するかを指定します。 Position が null または -1 の場合、データは現在のファイル位置から読み取られ、ファイル位置が更新されます。 Position が整数の場合、ファイルの位置は変更されません。 | |
折り返し電話 | 関数(エラー、バイト読み取り、バッファ) | 間違い |
readdir(path, options, callback)
ディレクトリ内のすべてのエントリを非同期的に読み取ります。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
options.withFileTypes | ブール値 | 間違い | 真実 | |
折り返し電話 | 関数(エラー、バッファ) | 間違い |
readFile(path, options, callback)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL |番号 | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
オプション.フラグ | 弦 | r | 真実 | |
オプション.シグナル | アボートシグナル | 真実 | ||
折り返し電話 | 関数(エラー、バッファ) | 間違い |
stat(path, options, callback)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL |番号 | 間違い | ファイル名またはファイル記述子 | |
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
オプション.フラグ | 弦 | r | 真実 | |
オプション.シグナル | アボートシグナル | 真実 | ||
折り返し電話 | 関数(エラー、データ) | 間違い |
writeFile(path, data, options, callback)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL |番号 | 間違い | ファイル名またはファイル記述子 | |
データ | 文字列 |バッファ |型付き配列 |データビュー |物体 | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
オプション.モード | 弦 | 0o666 | 真実 | |
オプション.フラグ | 弦 | w | 真実 | |
オプション.シグナル | アボートシグナル | 真実 | ||
折り返し電話 | 関数(エラー) | 間違い |
writev()
これはfs/index.js
内のwritev
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
access(path, mode, options)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode
ファイルへのアクセスを非同期的にチェックします。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
モード | 弦 | 真実 | ||
オプション | 物体 | 真実 |
chmod(path, mode)
外部ドキュメント: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
モード | 番号 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
mkdir(path, options)
ディレクトリを非同期的に作成します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 弦 | 間違い | 作成するパス | |
オプション | 物体 | 間違い | オプションの options 引数は、モード (パーミッションとスティッキー ビット) を指定する整数、または親ディレクトリを作成するかどうかを示すモード プロパティと再帰プロパティを持つオブジェクトにすることができます。 path が存在するディレクトリの場合に fs.mkdir() を呼び出すと、 recursive が false の場合にのみエラーが発生します。 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | プリミス | 成功すると、recursive が false の場合は未定義で満たされ、recursive が true の場合は最初に作成されたディレクトリ パスが満たされます。 |
open(path, flags, mode)
外部ドキュメント: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode
ファイルを非同期的に開きます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
フラグ | 弦 | 間違い | デフォルト: 'r' | |
モード | 弦 | 間違い | デフォルト: 0o666 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
opendir(path, options)
外部ドキュメント: https://nodejs.org/api/fs.html#fspromisesopendirpath-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
options.bufferSize | 番号 | 32 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ファイルシステム,ディレクトリ> |
readdir(path, options)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 弦 | utf8 | 真実 | |
options.withFileTypes | ブール値 | 間違い | 真実 |
readFile(path, options)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 弦 | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 文字列 |ヌル | ヌル | 真実 | |
オプション.フラグ | 弦 | r | 真実 | |
オプション.シグナル | アボートシグナル | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | プロミス<バッファ | 文字列> |
stat(path, options)
外部ドキュメント: https://nodejs.org/api/fs.html#fspromisesstatpath-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.bigint | ブール値 | 間違い | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
writeFile(path, data, options)
外部ドキュメント: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
パス | 文字列 |バッファ | URL |ファイルハンドル | 間違い | ファイル名またはファイルハンドル | |
データ | 文字列 |バッファ |配列 |データビュー |型付き配列 |ストリーム | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.エンコーディング | 文字列 |ヌル | utf8 | 間違い | |
オプション.モード | 番号 | 0o666 | 間違い | |
オプション.フラグ | 弦 | w | 間違い | |
オプション.シグナル | アボートシグナル | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
これはfs/stream.js
内のDEFAULT_STREAM_HIGH_WATER_MARK
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
ReadStream
( Readable
拡張) FileHandle
のReadable
ストリーム。
constructor()
ReadStream
クラスのコンストラクター
setHandle(handle)
ReadStream のファイル ハンドルを設定します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ハンドル | ファイルハンドル | 間違い |
highWaterMark()
ReadStream の最大バッファ サイズ。
path()
基になるFileHandle
の相対パスまたは絶対パス。
pending()
ストリームが保留状態にある場合はtrue
。
emit()
コンストラクターのoptions.emitClose
からshouldEmitClose
設定を処理します。
WriteStream
( Writable
拡張) FileHandle
のWritable
ストリーム。
constructor()
WriteStream
クラスのコンストラクター
setHandle(handle)
WriteStream のファイル ハンドルを設定します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ハンドル | ファイルハンドル | 間違い |
highWaterMark()
Writetream の最大バッファ サイズ。
path()
基になるFileHandle
の相対パスまたは絶対パス。
pending()
ストリームが保留状態にある場合はtrue
。
emit()
コンストラクターのoptions.emitClose
からshouldEmitClose
設定を処理します。
これはfs/stream.js
内のFileReadStream
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
これはfs/stream.js
内のFileWriteStream
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
これは低レベルの API であり、Socket SDK 上にライブラリを実装しない限り必要ありません。 Socket SDK アプリには 2 つまたは 3 つのプロセスがあります。
Render
プロセス、HTML、CSS、JS が実行される UI。Bridge
プロセスは、すべてを管理するコードの薄い層です。Main
プロセス。より重いコンピューティング ジョブを実行する必要があるアプリ用。電子とは異なり、これはオプションです。Bridge プロセスは Render プロセスと Main プロセスを管理し、それらの間でデータを仲介することもあります。
バインディング プロセスでは、通信方法として標準入出力を使用します。パイプの書き込み側に書き込まれたデータは、パイプの読み取り側から読み取られるまで OS によってバッファリングされます。
IPC プロトコルは、単純な URI のようなスキームを使用します。データは ArrayBuffers として渡されます。
ipc://command?key1=value1&key2=value2...
postMessage()
これはipc.js
のpostMessage
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
OK IPC ステータスを表します。
ERROR IPC ステータスを表します。
IPC リクエストのタイムアウト (ミリ秒単位)。
ipc.debug.enabled
プロパティのシンボル
parseSeq(seq, options)
seq
整数値として解析します
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
連続 | 文字列 |番号 | 間違い | ||
オプション | 物体 | 真実 | ||
オプション.bigint | ブール値 | 間違い | 間違い |
debug(enable)
debug.enabled === true
の場合、デバッグ出力がコンソールに出力されます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
有効にする | ブール値 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | ブール値 |
Message
( URL
拡張) ipc://
URI スキームに基づく IPC メッセージのコンテナー。
PROTOCOL()
IPC メッセージに予期されるプロトコル。
from(input, params)
さまざまな入力からMessage
インスタンスを作成します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
入力 | 文字列 | URL |メッセージ |バッファ |物体 | 間違い | ||
パラメータ | オブジェクト |文字列 | URLSearchParams | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | メッセージ |
isValidInput(input)
新しいMessage
インスタンスを構築するためにinput
が有効かどうかを判断するための述語。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
入力 | 文字列 | URL |メッセージ |バッファ |物体 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | ブール値 |
constructor(input)
Message
クラスのコンストラクター。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
入力 | 文字列 | URL | 間違い |
command()
計算された IPC メッセージ名。
name()
計算された IPC メッセージ名。
id()
コマンドの計算されたid
値。
seq()
コマンドの計算されたseq
(シーケンス) 値。
value()
メッセージ パラメータで指定される可能性がある計算されたメッセージ値。この値は自動的にデコードされますが、JSON として扱われません。
index()
コマンドの計算されたindex
値。コマンドのスコープが設定されている、またはコマンドの発信元のウィンドウ インデックスを参照している可能性があります。メッセージパラメータで指定されていない場合、この値はデフォルトの-1
になります。
json()
JSON として解析された計算値。値が存在しない場合、または無効な JSON である場合、この値はnull
なります。
params()
メッセージパラメータの計算された読み取り専用オブジェクト。
entries()
計算されたパラメータをエントリとして返します
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 配列<配列<文字列、混合>> |
set(key, value)
key
でパラメータvalue
を設定します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
鍵 | 弦 | 間違い | ||
価値 | 混合された | 間違い |
get(key, defaultValue)
key
でパラメータ値を取得します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
鍵 | 弦 | 間違い | ||
デフォルト値 | 混合された | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 混合された |
delete(key)
key
でパラメータを削除します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
鍵 | 弦 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | ブール値 |
keys()
計算されたパラメータキー。
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 配列 |
values()
計算されたパラメータ値。
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 配列 |
has(key)
パラメータにパラメータkey
が存在するかどうかを判断する述語。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
鍵 | 弦 | 間違い |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | ブール値 |
toJSON()
Message
インスタンスをプレーンな JSON オブジェクトに変換します。
{ err?, data? }
の形式のネイティブ層からの IPC 結果値を処理するために内部的に使用される結果タイプ。 { err?, data? }
.このタイプのオブジェクトのdata
とerr
プロパティはタプル形式であり、 [data?,err?]
でアクセスできます。
from(result, maybeError, maybeSource)
{ err?, data? }
のようなオブジェクトである入力からResult
インスタンスを作成します。 { err?, data? }
、 Error
インスタンス、または単なるdata
。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
結果 | オブジェクト |エラー |混合された | 真実 | ||
おそらくエラー | エラー | 真実 | ||
たぶん出典 | 弦 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 結果 |
constructor(err , data , source )
Result
クラスのコンストラクター。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
エラー | エラー | ヌル | 真実 | |
データ | 物体 | ヌル | 真実 | |
ソース | 弦 | 未定義 | 真実 |
length()
計算された結果の長さ。
ready()
ネイティブ IPC レイヤーの準備が整い、グローバル ウィンドウ オブジェクト上で公開されるまで待機します。
sendSync(command, params)
XHR 経由で同期 IPC コマンドを送信し、成功またはエラー時にResult
を返します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
指示 | 弦 | 間違い | ||
パラメータ | オブジェクト |弦 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 結果 |
emit(name, value, target , options)
window
オブジェクトで送出されるイベントを発行します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
名前 | 弦 | 間違い | ||
価値 | 混合 | 間違い | ||
ターゲット | イベント対象 | ウィンドウ | 真実 | |
オプション | 物体 | 真実 |
resolve(seq, value)
可能な値を使用してseq
によってリクエストを解決します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
連続 | 弦 | 間違い | ||
価値 | 混合 | 間違い |
send(command, value)
パラメーターを指定して非同期 IPC コマンド要求を送信します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
指示 | 弦 | 間違い | ||
価値 | 混合 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
write(command, params, buffer, options)
パラメータとバッファリングされたバイトを含む非同期 IPC コマンド リクエストを送信します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
指示 | 弦 | 間違い | ||
パラメータ | 物体 | 真実 | ||
バッファ | バッファ |タイプ配列 |配列バッファ |文字列 |配列 | 真実 | ||
オプション | 物体 | 真実 |
request(command, params, options)
バッファリングされたバイトによる応答を要求するパラメータを含む非同期 IPC コマンド要求を送信します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
指示 | 弦 | 間違い | ||
パラメータ | 物体 | 真実 | ||
オプション | 物体 | 真実 |
createBinding(domain, ctx)
プロキシベースの IPC API を作成するためのファクトリ。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
ドメイン | 弦 | 間違い | ||
ctx | 関数 |物体 | 真実 | ||
ctx.デフォルト | 弦 | 真実 |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | プロキシ |
このモジュールは、すべての主要なオペレーティング システムからの正規化されたシステム情報を提供します。
arch()
これはos.js
のarch
という名前のFunctionDeclaration
で、エクスポートされていますが文書化されていません。
networkInterfaces()
これはos.js
のnetworkInterfaces
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
platform()
これはos.js
のplatform
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
type()
これはos.js
のtype
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
isWindows()
これはos.js
のisWindows
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
tmpdir()
これはos.js
のtmpdir
という名前のFunctionDeclaration
で、エクスポートされていますが文書化されていません。
これはos.js
のEOL
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
これはpath/path.js
内のPath
という名前のClassDeclaration
で、エクスポートされていますが文書化されていません。
cwd(opts)
現在の作業ディレクトリのパスを計算します。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
選択します | 物体 | 真実 | ||
opts.posix POSIX スタイルのパスを強制するにはtrue に設定します | ブール値 | 真実 |
constructor(opts)
Path
クラスのコンストラクター。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
選択します | 物体 | 真実 | ||
opts.root | 弦 | 真実 | ||
opts.base | 弦 | 真実 | ||
オプションの名前 | 弦 | 真実 | ||
opts.dir | 弦 | 真実 | ||
opts.ext | 弦 | 真実 |
resolve()
normalize()
homedir()
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 弦 | 現在のユーザーのホーム ディレクトリ。 |
exit(code)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
コード | 番号 | 0 | 真実 | 終了コード。デフォルト: 0。 |
ランタイム固有のメソッドを提供します
これはruntime.js
のcurrentWindow
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
これはruntime.js
のdebug
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
これはruntime.js
のconfig
という名前のVariableDeclaration
であり、エクスポートされていますが文書化されていません。
send()
これはruntime.js
のsend
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
getWindows()
これはruntime.js
内のgetWindows
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
openExternal()
これはruntime.js
のopenExternal
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
exit(options)
バックエンド プロセスを終了し、次にレンダリング プロセスを終了します。使用される終了コードは、OS への最終終了コードです。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
オプション | 物体 | 間違い | オプションオブジェクト |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
setTitle(options)
ウィンドウのタイトルを設定します (該当する場合)。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
オプション | 物体 | 間違い | オプションオブジェクト |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ipc.Result> |
inspect()
これはruntime.js
のinspect
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
show(opts)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
選択します | 物体 | 間違い | オプションオブジェクト |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ipc.Result> |
hide(opts)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
選択します | 物体 | 間違い | オプションオブジェクト |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ipc.Result> |
navigate(opts)
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
選択します | 物体 | 間違い | オプションオブジェクト | |
オプトウィンドウ | 番号 | 現在のウィンドウ | 間違い | ウィンドウのインデックス |
opts.url | 番号 | 間違い | ウィンドウにロードする HTML ファイルへのパス |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | Promise<ipc.Result> |
setWindowBackgroundColor()
これはruntime.js
のsetWindowBackgroundColor
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
setContextMenu(options)
ネイティブのコンテキスト メニューを開きます。
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
オプション | 物体 | 間違い | オプションオブジェクト |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
setSystemMenuItemEnabled()
これはruntime.js
内のsetSystemMenuItemEnabled
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。
setSystemMenu(options)
アプリのネイティブメニューを設定します。
Socket Runtime は、クロスプラットフォームのネイティブ システムとコンテキスト メニューを簡単に作成できる最小限の DSL を提供します。
メニューは実行時に作成されます。これらは、メイン プロセスまたはレンダー プロセスから作成できます。これらは、 setSystemMenu
メソッドを呼び出すことで即座に再作成できます。
このメソッドは文字列を受け取ります。メニューの一例をご紹介します。セミコロンはメニューの終わりを示します。アクセラレータ キーがない場合はアンダースコアを使用します。修飾子はオプションです。また、編集メニューなどのよく知られた OS メニュー オプションでは、指定する必要のないアクセラレータが自動的に取得されます。
socket . runtime . setSystemMenu ( { index : 0 , value : `
App:
Foo: f;
Edit:
Cut: x
Copy: c
Paste: v
Delete: _
Select All: a;
Other:
Apple: _
Another Test: T
!Im Disabled: I
Some Thing: S + Meta
---
Bazz: s + Meta, Control, Alt;
` )
区切り文字を作成するには、3 つのダッシュ---
を使用します。
アクセラレータ修飾子は視覚的なインジケーターとして使用されますが、実際のキー バインドはイベント リスナーで行われるため、実質的な影響はありません。
大文字は、アクセラレータがShift
キーによって変更されることを意味します。
追加のアクセラレータはMeta
、 Control
、 Option
、それぞれカンマで区切られます。プラットフォームに適用できないものは無視されます。
MacOS では、 Meta
Command
と同じです。
メニュー項目を無効にしたい場合は、項目の前に!
を付けるだけです。キャラクター。これにより、システム メニューが表示されるときに項目が無効に表示されます。
ネストされたメニューはアンチパターンであると感じます。私たちはそれらを使用しません。それらに対する強力な議論と、それらを機能させるための非常に単純なプルリクエストがある場合は、それらを検討する可能性があります。
メニュー項目がアクティブ化されると、フロントエンド コードでmenuItemSelected
イベントが発生し、必要に応じてそこからバックエンド コードと通信できます。
たとえば、 Other
メニューからApple
アイテムが選択された場合...
window . addEventListener ( 'menuItemSelected' , event => {
assert ( event . detail . parent === 'Other' )
assert ( event . detail . title === 'Apple' )
} )
口論 | タイプ | デフォルト | オプション | 説明 |
---|---|---|---|---|
オプション | 物体 | 間違い | オプションオブジェクト | |
オプション.値 | 弦 | 間違い | メニューのレイアウト | |
オプション.インデックス | 番号 | 間違い | ターゲットとするウィンドウ (該当する場合) |
戻り値 | タイプ | 説明 |
---|---|---|
指定されていない | 約束 |
reload()
これはruntime.js
のreload
という名前のFunctionDeclaration
であり、エクスポートされていますが文書化されていません。