Updating documentation about aborting a streamed response (#139)

ollama · Aug 30, 2024 · 218bede · 218bede
1 parent c03ea59
commit 218bede
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -198,6 +198,15 @@ ollama.ps()
 
 - Returns: `<ListResponse>`
 
+### abort
+
+```javascript
+ollama.abort()
+```
+
+This method will abort all streamed generations currently running.
+All asynchronous threads listening to streams (typically the ```for await (const part of response)```) will throw an ```AbortError``` exception
+
 ## Custom client
 
 A custom client can be created with the following fields: