Internal Private generateInternal Generates a short, unique request id for request correlation.
Issues a correlated fs:request to the backend and awaits its outcome.
This is the low-level entry point for the git/filesystem protocol. The
client emits fs:request with a JSON-string payload ({ req, op, ...params }),
and the backend replies with one of three events, all correlated by req
and all carrying a JSON-string args[0]:
fs:result — success; resolves with the parsed datafs:error — failure; rejects with an FsError (plus collected output)fs:progress — streaming stdout/stderr/progress lines (collected for error context)Typed convenience wrappers live on GitSocket (WispSocket.Git) and FilesystemSocket (WispSocket.Filesystem); call this directly for ops that don't have a typed wrapper yet.
The operation name (e.g. git-pull, list)
Additional payload fields merged into the request (e.g. { directory })
In milliseconds, how long to wait for the result
const status = await wisp.socket.request("git-status", { directory: "/garrysmod/addons/acf-3" })
Internal Runs a job on an available pool worker, handing it the worker's socket and logger. Used for event-based flows (e.g. file search) that don't fit the request request/response protocol.
The job to run; receives the worker and returns a Promise
Sends a command to the server and then waits until output with the given prefix is seen in a console message
The short, unique string that your output will be prefixed with
The full command string to send
In milliseconds, how long to wait for output before timing out
Runs a custom lua command that will prefix its output with our nonce, then prints the output from that command
-- lua/autorun/server/nonce_example.lua
concommand.Add( "myCommand", function( ply, _, args )
if IsValid( ply ) then return end
local nonce = args[1]
print( nonce .. "Command output" )
end )
const nonce = "abc123";
const command = `myCommand "${nonce}"`;
try {
const output = await wisp.socket.sendCommandNonce(nonce, command);
console.log("Output from command:", output);
catch (error) {
console.error(error);
}
ℹ️ This is useful if you run code on your Server that will print output with the same prefix, letting you run commands and also receive output for it
Sets a callback to run on the Websocket Info before saving the details.
The callback to run when the data is received from the API
// Change the URL of the Websocket
wisp.socket.setWebsocketDetailsPreprocessor((info) => {
info.url = "wss://newurl.com"
})
ℹ️ This can be used to modify the URL or token after its retrieved from the API
Generated using TypeDoc
The primary interface to the Websocket API