Browse Source

Updating documentation about aborting a streamed response (#139)

Florent Genette 10 months ago
parent
commit
218bede172
1 changed files with 9 additions and 0 deletions
  1. 9 0
      README.md

+ 9 - 0
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: