socket api下載 - socket api源碼下載

socket api

其他類別

1.0.0

下載

藍牙

用於藍牙 Pub-Sub 的高級跨平台 API

`Bluetooth` （擴展`EventEmitter` ）

建立藍牙服務的實例。

`constructor(serviceId)`

constructor 是設定為true範例屬性使用鍵值對建立新服務

爭論	類型	預設	選修的	描述
服務ID	細繩		錯誤的	給定預設值來確定類型

`start()`

啟動藍牙服務。

傳回值	類型	描述
未指定	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 的緩衝模組，用於瀏覽器。

緩衝

If Buffer.TYPED_ARRAY_SUPPORT : === true 使用 Uint8Array 實作（最快） === false 列印警告並建議使用具有 Object 實現的buffer v4.x（最相容，甚至 IE6）

支援類型化陣列的瀏覽器有 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的支持，並且有一個有缺陷的類型數組實現。

不明確的

If Buffer.TYPED_ARRAY_SUPPORT : === true 使用 Uint8Array 實作（最快） === false 列印警告並建議使用具有 Object 實現的buffer v4.x（最相容，甚至 IE6）

支援類型化陣列的瀏覽器有 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的支持，並且有一個有缺陷的類型數組實現。

不明確的

If Buffer.TYPED_ARRAY_SUPPORT : === true 使用 Uint8Array 實作（最快） === false 列印警告並建議使用具有 Object 實現的buffer v4.x（最相容，甚至 IE6）

支援類型化陣列的瀏覽器有 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的支持，並且有一個有缺陷的類型數組實現。

不明確的

If Buffer.TYPED_ARRAY_SUPPORT : === true 使用 Uint8Array 實作（最快） === false 列印警告並建議使用具有 Object 實現的buffer v4.x（最相容，甚至 IE6）

支援類型化陣列的瀏覽器有 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中

爭論	類型	預設	選修的	描述
緩衝	類型數組		錯誤的

傳回值	類型	描述
未指定	類型數組

隨機位元組配額

每頁隨機位元組的最大總大小

最大隨機位元組數

隨機位元組的最大總大小。

MAX_RANDOM_BYTES_PAGES

每頁分配的最大位元組總數（最大/配額）

`randomBytes(size)`

產生size隨機位元組。

爭論	類型	預設	選修的	描述
尺寸	數位		錯誤的	要產生的位元組數。大小不得大於 2**31 - 1。

傳回值	類型	描述
未指定	緩衝	一個使用隨機位元組的 socket.Buffer 實例解析的承諾。

`createDigest(algorithm, message)`

爭論	類型	預設	選修的	描述
演算法	細繩		錯誤的	`SHA-1`
訊息	緩衝器\|類型化數組 \|資料視圖		錯誤的	socket.Buffer、TypedArray 或 Dataview 的實例。

傳回值	類型	描述
未指定	承諾	一個使用帶有雜湊值的 socket.Buffer 實例進行解析的承諾。

德格拉姆

此模組提供了 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”。必需的。
選項.reuseAddr	布林值	錯誤的	真的	當 true 時，socket.bind() 將重複使用該位址，即使另一個進程已經在其上綁定了套接字。預設值：假。
選項.ipv6Only	布林值	錯誤的	真的	將 ipv6Only 設為 true 將禁用雙棧支持，即綁定到地址 :: 不會綁定 0.0.0.0。預設值：假。
選項.recvBufferSize	數位		真的	設定 SO_RCVBUF 套接字值。
選項.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

在指定連接埠和選用位址上偵聽資料封包訊息如果未指定位址，作業系統將嘗試偵聽所有位址。綁定完成後，將發出“監聽”事件並呼叫可選的回調函數。

如果綁定失敗，則會發出「錯誤」事件。

爭論	類型	選修的	描述
港口	數位	錯誤的	監聽訊息的連接埠
地址	細繩	錯誤的	要綁定的位址 (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() 方法的公共參數。將會被加入為「連線」事件的偵聽器一次。

`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，則偏移量和長度分別指定訊息開始的 Buffer 內的偏移量和訊息中的位元組數。如果 msg 是一個 String，那麼它會自動轉換為 'utf8' 編碼的 Buffer。對於包含多位元組字元的訊息，偏移量和長度將根據位元組長度而不是字元位置來計算。如果 msg 是數組，則不得指定偏移量和長度。

地址參數是一個字串。如果address的值為主機名，則將使用DNS來解析主機的位址。如果未提供位址或位址為空，則預設使用「127.0.0.1」（對於 udp4 套接字）或「::1」（對於 udp6 套接字）。

如果之前未透過呼叫綁定來綁定套接字，則會為套接字分配一個隨機連接埠號，並綁定到“所有介面”位址（對於udp4 套接字為“0.0.0.0”，對於udp6套接字為“::0” .)

可以指定一個可選的回呼函數作為報告 DNS 錯誤或決定何時可以安全地重複使用 buf 物件的方法。 DNS 查找會延遲 Node.js 事件循環至少一個週期的傳送時間。

確定資料報已發送的唯一方法是使用回調。如果發生錯誤並給出回調，則錯誤將作為第一個參數傳遞給回調。如果未給予回調，則錯誤將作為套接字物件上的「錯誤」事件發出。

偏移量和長度是可選的，但如果使用其中任何一個，則必須設定兩者。只有當第一個參數是 Buffer、TypedArray 或 DataView 時才支援它們。

爭論	類型	選修的	描述
味精	緩衝器\|類型化數組 \|資料視圖 \|字串\|大批	錯誤的	待發送的訊息。
抵銷	整數	真的	訊息開始的緩衝區中的偏移量。
長度	整數	真的	訊息中的位元組數。
港口	整數	真的	目的港。
地址	細繩	真的	目標主機名稱或 IP 位址。
打回來	功能	真的	訊息發送後調用。

`close(callback)`

外部文件：https://nodejs.org/api/dgram.html#socketclosecallback

關閉底層套接字並停止偵聽其上的資料。如果提供了回調，則會將其新增為「關閉」事件的偵聽器。

爭論	類型	預設	選修的	描述
打回來	功能		真的	連接完成或出錯時調用。

`address()`

外部文件：https://nodejs.org/api/dgram.html#socketaddress

傳回一個包含套接字位址資訊的物件。對於 UDP 套接字，該物件將包含位址、系列和連接埠屬性。

如果在未綁定的套接字上呼叫此方法，則會拋出 EBADF。

傳回值	類型	描述
套接字訊息	目的	有關本地套接字的信息
套接字資訊位址	細繩	套接字的IP位址
套接字資訊端口	細繩	套接字的端口
socketInfo.family	細繩	套接字的IP系列

`remoteAddress()`

外部文件：https://nodejs.org/api/dgram.html#socketremoteaddress

傳回一個包含遠端端點的位址、系列和連接埠的物件。如果套接字未連接，此方法將引發 ERR_SOCKET_DGRAM_NOT_CONNECTED 異常。

傳回值	類型	描述
套接字訊息	目的	有關遠端套接字的信息
套接字資訊位址	細繩	套接字的IP位址
套接字資訊端口	細繩	套接字的端口
socketInfo.family	細繩	套接字的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) 記錄。所有選項屬性都是可選的。如果 options 是整數，則它必須是 4 或 6 – 如果 options 是 0 或未提供，則如果找到，則傳回 IPv4 和 IPv6 位址。

從 Node.js 網站...

當 all 選項設為 true 時，回呼的參數將變更為 (err, 位址)，其中位址是具有屬性 address 和 family 的物件陣列。

發生錯誤時， err 是 Error 對象，其中 err.code 是錯誤代碼。請記住，不僅當主機名稱不存在時，而且當查找因其他原因（例如沒有可用的檔案描述符）失敗時，err.code 都會被設定為「ENOTFOUND」。 dns.lookup() 不一定與 DNS 協定有任何關係。此實作使用可以將名稱與位址關聯起來的作業系統工具，反之亦然。這種實作可能會對任何 Node.js 程式的行為產生微妙但重要的影響。在使用 dns.lookup() 之前，請花一些時間查閱實作注意事項部分。

爭論	類型	預設	選修的	描述
主機名稱	細繩		錯誤的	要解析的主機名稱。
選擇	目的		真的	一個選項物件。
選擇家庭	數量 \|細繩	0	錯誤的	唱片家族。必須為 4、6 或 0。值0表示同時回傳IPv4和IPv6位址。預設值：0。
CB	功能		錯誤的	方法完成後呼叫的函數。

DNS.承諾

此模組支援名稱解析。例如，用它來尋找主機名稱的 IP 位址。儘管以網域名稱系統 (DNS) 命名，但它並不總是使用 DNS 協定進行查找。 dns.lookup() 使用作業系統工具來執行名稱解析。它可能不需要執行任何網路通訊。若要像同一系統上的其他應用程式一樣執行名稱解析，請使用 dns.lookup()。

`lookup(hostname, opts)`

外部文件：https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options

爭論	類型	預設	選修的	描述
主機名稱	細繩		錯誤的	要解析的主機名稱。
選擇	目的		真的	一個選項物件。
選擇家庭	數量 \|細繩	0	錯誤的	唱片家族。必須為 4、6 或 0。值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：

 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 。

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
模式	細繩	F_OK(0)	真的
打回來	函數（錯誤，fd）		錯誤的

`chmod(path, mode, callback)`

外部文件：https://nodejs.org/api/fs.html#fschmodpath-mode-callback

異步更改文件的權限。除了可能的異常之外，不會向完成回調提供任何參數

爭論	類型	選修的
小路	字串\|緩衝器\|網址	錯誤的
模式	數位	錯誤的
打回來	函數（錯誤）	錯誤的

`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

爭論	類型	預設	選修的	描述
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的

傳回值	類型	描述
未指定	fs.ReadStream

`createWriteStream(path, options)`

外部文件：https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

爭論	類型	預設	選修的	描述
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的

傳回值	類型	描述
未指定	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 。

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
旗幟	細繩	r	真的
模式	細繩	0o666	真的
打回來	函數（錯誤，fd）		錯誤的

`opendir(path, options, callback)`

非同步開啟一個目錄，在成功或錯誤時呼叫callback 。

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項.withFileTypes	布林值	錯誤的	真的
打回來	函數（錯誤，fd）		錯誤的

`read(fd, buffer, offset, length, position, callback)`

從開啟的檔案描述符非同步讀取。

爭論	類型	選修的	描述
FD	數位	錯誤的
緩衝	對象\|緩衝器\|類型數組	錯誤的	資料將寫入的緩衝區。
抵銷	數位	錯誤的	緩衝區中要寫入資料的位置。
長度	數位	錯誤的	要讀取的位元組數。
位置	數量 \|大整數 \|無效的	錯誤的	指定從文件中的何處開始讀取。如果position為null或-1，將從目前檔案位置讀取數據，並更新檔案位置。如果position是整數，則檔案位置將保持不變。
打回來	函數（錯誤，位元組讀取，緩衝區）	錯誤的

`readdir(path, options, callback)`

非同步讀取目錄中的所有條目。

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項.withFileTypes	布林值	錯誤的	真的
打回來	函數（錯誤，緩衝區）		錯誤的

`readFile(path, options, callback)`

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址 \|數位		錯誤的
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項標誌	細繩	r	真的
選項.訊號	中止訊號		真的
打回來	函數（錯誤，緩衝區）		錯誤的

`stat(path, options, callback)`

爭論	類型	預設	選修的	描述
小路	字串\|緩衝器\|網址 \|數位		錯誤的	檔案名稱或檔案描述符
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項標誌	細繩	r	真的
選項.訊號	中止訊號		真的
打回來	函數（錯誤，數據）		錯誤的

`writeFile(path, data, options, callback)`

爭論	類型	預設	選修的	描述
小路	字串\|緩衝器\|網址 \|數位		錯誤的	檔案名稱或檔案描述符
數據	字串\|緩衝器\|類型化數組 \|資料視圖 \|目的		錯誤的
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項.模式	細繩	0o666	真的
選項標誌	細繩	w	真的
選項.訊號	中止訊號		真的
打回來	函數（錯誤）		錯誤的

`writev()`

這是fs/index.js中名為writev FunctionDeclaration ，它已匯出但未記錄。

FS.承諾

`access(path, mode, options)`

外部文件：https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode

非同步檢查文件存取。

爭論	類型	選修的
小路	字串\|緩衝器\|網址	錯誤的
模式	細繩	真的
選項	目的	真的

`chmod(path, mode)`

外部文件：https://nodejs.org/api/fs.html#fspromiseschmodpath-mode

爭論	類型	預設	選修的	描述
小路	字串\|緩衝器\|網址		錯誤的
模式	數位		錯誤的

傳回值	類型	描述
未指定	承諾

`mkdir(path, options)`

異步建立目錄。

爭論	類型	預設	選修的	描述
小路	細繩		錯誤的	創建路徑
選項	目的		錯誤的	可選的選項參數可以是指定模式（權限和黏性位元）的整數，也可以是具有模式屬性和指示是否應建立父目錄的遞歸屬性的物件。只有當 recursive 為 false 時，當 path 是存在的目錄時呼叫 fs.mkdir() 才會導致錯誤。

傳回值	類型	描述
未指定	普里米斯	成功後，如果 recursive 為 false，則傳回 undefined；如果 recursive 為 true，則傳回建立的第一個目錄路徑。

`open(path, flags, mode)`

外部文件：https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode

異步打開文件。

爭論	類型	選修的	描述
小路	字串\|緩衝器\|網址	錯誤的
旗幟	細繩	錯誤的	預設值：“r”
模式	細繩	錯誤的	預設值：0o666

傳回值	類型	描述
未指定	承諾

`opendir(path, options)`

外部文件：https://nodejs.org/api/fs.html#fspromisesopendirpath-options

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項.bufferSize	數位	32	真的

傳回值	類型	描述
未指定	Promise<檔案系統，目錄>

`readdir(path, options)`

外部文件：https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的
選項.encoding	細繩	UTF8	真的
選項.withFileTypes	布林值	錯誤的	真的

`readFile(path, options)`

外部文件：https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options

爭論	類型	預設	選修的
小路	細繩		錯誤的
選項	目的		真的
選項.encoding	字串\|無效的	無效的	真的
選項標誌	細繩	r	真的
選項.訊號	中止訊號		真的

傳回值	類型	描述
未指定	承諾<緩衝區	字串>

`stat(path, options)`

外部文件：https://nodejs.org/api/fs.html#fspromisesstatpath-options

爭論	類型	預設	選修的
小路	字串\|緩衝器\|網址		錯誤的
選項	目的		真的
選項.bigint	布林值	錯誤的	真的

傳回值	類型	描述
未指定	承諾

`writeFile(path, data, options)`

外部文件：https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options

爭論	類型	預設	選修的	描述
小路	字串\|緩衝器\|網址 \|文件句柄		錯誤的	檔案名稱或檔案句柄
數據	字串\|緩衝器\|數組 \|資料視圖 \|類型化數組 \|溪流		錯誤的
選項	目的		真的
選項.encoding	字串\|無效的	UTF8	錯誤的
選項.模式	數位	0o666	錯誤的
選項標誌	細繩	w	錯誤的
選項.訊號	中止訊號		真的

傳回值	類型	描述
未指定	承諾

FS流

DEFAULT_STREAM_HIGH_WATER_MARK

這是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 應用程式有兩個或三個進程。

Render進程，即執行 HTML、CSS 和 JS 的 UI。
Bridge進程，管理一切的薄層程式碼。
Main進程，適用於需要執行較繁重計算作業的應用程式。與電子不同的是，它是可選的。

Bridge 進程管理 Render 和 Main 進程，它還可以在它們之間代理資料。

綁定過程使用標準輸入和輸出作為通訊方式。寫入管道寫入端的資料由作業系統緩衝，直到從管道讀取端讀取。

IPC 協定使用簡單的類似 URI 的方案。數據作為 ArrayBuffer 傳遞。

 ipc://command?key1=value1&key2=value2...

`postMessage()`

這是ipc.js中名為postMessage的FunctionDeclaration ，它已匯出但未記錄。

好的

表示 IPC 狀態正常。

錯誤

表示 ERROR IPC 狀態。

暫停

IPC 請求的逾時（以毫秒為單位）。

k調試啟用

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搜尋參數		真的

傳回值	類型	描述
未指定	訊息

`isValidInput(input)`

用於確定input對於建構新Message實例是否有效的謂詞。

爭論	類型	預設	選修的	描述
輸入	字串\|網址 \|留言 \|緩衝器\|目的		錯誤的

傳回值	類型	描述
未指定	布林值

`constructor(input)`

Message類別建構函數。

爭論	類型	預設	選修的	描述
輸入	字串\|網址		錯誤的

`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 物件。

結果

內部使用的結果類型，用於處理來自本機層的 IPC 結果值，其形式為{ err?, data? } 。此類物件的data和err屬性採用元組形式，可透過[data?,err?]存取

`from(result, maybeError, maybeSource)`

從輸入建立一個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 設定為`true`以強制 POSIX 樣式路徑	布林值		真的

`constructor(opts)`

Path類構造函數。

爭論	類型	選修的
選擇	目的	真的
選項根目錄	細繩	真的
選項庫	細繩	真的
選擇名稱	細繩	真的
選項目錄	細繩	真的
選擇.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)`

退出後端進程，然後退出渲染進程，使用的退出代碼是作業系統的最終退出代碼。

爭論	類型	預設	選修的	描述
選項	目的		錯誤的	一個選項對象

傳回值	類型	描述
未指定	承諾

`setTitle(options)`

設定視窗的標題（如果適用）。

爭論	類型	預設	選修的	描述
選項	目的		錯誤的	一個選項對象

傳回值	類型	描述
未指定	Promise<ipc.Result>

`inspect()`

這是一個在runtime.js中名為inspect的FunctionDeclaration ，它已匯出但未記錄。

`show(opts)`

爭論	類型	預設	選修的	描述
選擇	目的		錯誤的	一個選項對象

傳回值	類型	描述
未指定	Promise<ipc.Result>

`hide(opts)`

爭論	類型	預設	選修的	描述
選擇	目的		錯誤的	一個選項對象

傳回值	類型	描述
未指定	Promise<ipc.Result>

`navigate(opts)`

爭論	類型	預設	選修的	描述
選擇	目的		錯誤的	一個選項對象
選擇視窗	數位	目前視窗	錯誤的	視窗的索引
選項.url	數位		錯誤的	要載入到視窗中的 HTML 檔案的路徑

傳回值	類型	描述
未指定	Promise<ipc.Result>

`setWindowBackgroundColor()`

這是runtime.js中名為setWindowBackgroundColor的FunctionDeclaration ，它已匯出但未記錄。

`setContextMenu(options)`

開啟本機上下文選單。

爭論	類型	預設	選修的	描述
選項	目的		錯誤的	一個選項對象

傳回值	類型	描述
未指定	承諾

`setSystemMenuItemEnabled()`

這是runtime.js中名為setSystemMenuItemEnabled的FunctionDeclaration ，它已匯出但未記錄。

`setSystemMenu(options)`

設定應用程式的本機選單。

Socket Runtime 提供了極簡的 DSL，可輕鬆建立跨平臺本機系統和上下文選單。

選單是在運行時創建的。它們可以從主程序或渲染程序建立。可以透過呼叫setSystemMenu方法立即重新建立它們。

該方法需要一個字串。這是菜單的範例。分號很重要，表示菜單的結尾。當沒有加速鍵時使用下劃線。修飾符是可選的。眾所周知的作業系統選單選項（例如編輯選單）將自動取得加速器，您無需指定它們。

 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;
` )

分離器

若要建立分隔符，請使用三個破折號--- 。

加速器修改器

加速鍵修飾符用作視覺指示器，但不會產生實質影響，因為實際的鍵綁定是在事件偵聽器中完成的。

大寫字母表示加速器是透過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 ，它已匯出但未記錄。

溪流

展開

附加信息

版本 1.0.0
類型其他類別
更新時間 2025-01-04
大小 130.88KB
來自於 Github

相關應用

cloud sql jdbc socket factory

2024-11-05
sample node api

2024-11-05
aspera api examples

2024-11-04
evolution api

2024-11-03
加油優惠APP源碼可二開另外底價提供團油API API API

2022-12-06
Workerman(高效能PHP Socket框架)

2022-10-31

爲您推薦

chat.petals.dev

其他源碼

1.0.0
GPT Prompt Templates

其他源碼

1.0.0
GPTyped

其他源碼

GPTyped 1.0.5
ugai

其他類別

1.0.0
internet speed

其他類別

1.0.0
surma

其他類別

surma 1.0
wp functions

其他類別

1.0.0
waymo open dataset

其他源碼

December 2023 Update
slugify

其他類別

Version 4.6.0 (10 September 2024)

相關資訊全部

socket api

藍牙

Bluetooth （擴展EventEmitter ）

constructor(serviceId)

start()

subscribe(id )

publish(id, value)

緩衝

緩衝

不明確的

不明確的

不明確的

不明確的

緩衝

不明確的

不明確的

不明確的

緩衝

不明確的

不明確的

不明確的

緩衝

不明確的

不明確的

不明確的

緩衝

不明確的

不明確的

不明確的

加密貨幣

網路加密

getRandomValues(buffer)

隨機位元組配額

最大隨機位元組數

MAX_RANDOM_BYTES_PAGES

randomBytes(size)

createDigest(algorithm, message)

德格拉姆

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 （擴展EventEmitter ）

bind(port, address, callback)

connect(port, host, connectListener)

disconnect()

send(msg, offset, length, port, address, callback)

close(callback)

address()

remoteAddress()

setRecvBufferSize(size)

setSendBufferSize(size)

getRecvBufferSize()

getSendBufferSize()

域名系統

lookup(hostname, opts, cb)

DNS.承諾

lookup(hostname, opts)

檔案系統

access(path, mode , callback)

chmod(path, mode, callback)

close(fd, callback)

copyFile()

createReadStream(path, options)

createWriteStream(path, options)

fstat(fd, options, callback)

open(path, flags , mode , callback)

opendir(path, options, callback)

read(fd, buffer, offset, length, position, callback)

readdir(path, options, callback)

readFile(path, options, callback)

stat(path, options, callback)

writeFile(path, data, options, callback)

writev()

FS.承諾

access(path, mode, options)

chmod(path, mode)

`Bluetooth` （擴展`EventEmitter` ）

`constructor(serviceId)`

`start()`

`subscribe(id )`

`publish(id, value)`

`getRandomValues(buffer)`

`randomBytes(size)`

`createDigest(algorithm, message)`

`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` （擴展`EventEmitter` ）

`bind(port, address, callback)`

`connect(port, host, connectListener)`

`disconnect()`

`send(msg, offset, length, port, address, callback)`

`close(callback)`

`address()`

`remoteAddress()`

`setRecvBufferSize(size)`

`setSendBufferSize(size)`

`getRecvBufferSize()`

`getSendBufferSize()`

`lookup(hostname, opts, cb)`

`lookup(hostname, opts)`

`access(path, mode , callback)`

`chmod(path, mode, callback)`

`close(fd, callback)`

`copyFile()`

`createReadStream(path, options)`

`createWriteStream(path, options)`

`fstat(fd, options, callback)`

`open(path, flags , mode , callback)`

`opendir(path, options, callback)`

`read(fd, buffer, offset, length, position, callback)`

`readdir(path, options, callback)`

`readFile(path, options, callback)`

`stat(path, options, callback)`

`writeFile(path, data, options, callback)`

`writev()`

`access(path, mode, options)`

`chmod(path, mode)`

`mkdir(path, options)`

`open(path, flags, mode)`

`opendir(path, options)`

`readdir(path, options)`

`readFile(path, options)`

`stat(path, options)`

`writeFile(path, data, options)`

`ReadStream` （擴充`Readable` ）

`constructor()`

`setHandle(handle)`

`highWaterMark()`

`path()`

`pending()`

`emit()`

`WriteStream` （擴充`Writable` ）

`constructor()`

`setHandle(handle)`

`highWaterMark()`

`path()`

`pending()`

`emit()`

`postMessage()`

`parseSeq(seq, options)`

`debug(enable)`

`Message` （擴展`URL` ）

`PROTOCOL()`

`from(input, params)`

`isValidInput(input)`

`constructor(input)`

`command()`

`name()`

`id()`

`seq()`

`value()`