Dispose result

This method should be always called when a result is not needed anymore. It disposes the result and releases allocated resources of that result.

APIMethod
RESTPOST result/{result-id}/dispose
IPCresult/dispose
Python IPCResult.dispose
Return typeResultState

Examples

Python IPC

# it is important to dispose a result when it is not needed anymore
result.dispose()

JSON-RPC via Fetch API

The example below shows the usage of this method using the JSON-RPC protocol via the Fetch API which is available in modern web-browsers or platforms like Deno.

  let resp = await fetch("http://localhost:8080", {
    method: "POST",
    body: JSON.stringify({
      jsonrpc: "2.0",
      id: 1,
      method: "result/dispose",
      params: {
        "@id": "e316a369-bf5b-4c25-a61f-3492cfca9535",
      }
    })
  });
  let v = await resp.json();
  console.log(v);
  // {
  //    jsonrpc: "2.0",
  //    result: {
  //      "@id": "e316a369-bf5b-4c25-a61f-3492cfca9535"
  //    },
  //    id: 1
  //  }