Skip to content

Commit 781f475

Browse files
docs: update rendering status methods doc.
1 parent b78aff4 commit 781f475

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/PROJECTS_API.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,8 @@ Renderforest.renderProject(4120385, { quality: 360, watermark: 'https://example.
200200
### Get rendering status
201201

202202
Our rendering status method uses user's defined `callback` to manage rendering status percentage
203-
and uses error first callback pattern. If you want to unsubscribe from getting rendering status then simply call
203+
and uses error first callback pattern. If you want to unsubscribe from getting rendering status
204+
(before rendering finishes) then simply call
204205
`unsubscribe` (`getRenderingStatus` method returns function to unsubscribe from getting rendering status).
205206

206207
```js
@@ -216,7 +217,7 @@ Renderforest.renderProject(15431416, { quality: 720 })
216217
}
217218
// take percentage from here
218219
console.log(percentage)
219-
// if you want in unsubscribe in some case, then simply call unsubscribe
220+
// if you want in unsubscribe (before rendering finishes) for some reason, then simply call unsubscribe
220221
unsubscribe()
221222
})
222223
})

0 commit comments

Comments
 (0)