j/Mind_Reader
1
0
Fork 0
mirror of https://github.com/We-Dont-Byte/Mind_Reader.git synced 2025-01-18 18:45:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add clarification comment to send

Browse Source
This commit is contained in:
jakergrossman 2021-11-18 00:38:07 -06:00
parent 92d42edaff
commit 95b23236e0
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/hubManager.ts
View File

@ -150,14 +150,18 @@ export default class HubManager {
}
/**
* Send an RPC message and get the corresponding response.
* Send an RPC message. The corresponding Promise resolve
* is saved into the `pendingRequests` map. When an inbound
* message is found that matches an ID in `pendingRequests`,
* the corresponding resolve is called. So, even though
* the `resolve` call does not appear explicitly here, it *does*
* get resolved at the appropriate time.
*
* @param `proc` Procedure to execute
* @param `params` Optional parameters for the procedure
* @param `id` The ID to use for the RPC message. Use null to indicate no ID/notification message.
* If neither a string or `null` is passed, an ID is automatically generated.
*/
// TODO: make send take a single RPCRequest argument, made inline in each function
public async send(request: RPCRequest): Promise<RPCResponse> {
return new Promise((resolve, reject) => {
if (request['i'] === undefined) {