Skip to content

Commit 10adb53

Browse files
root(readme): update getProjects documentation.
1 parent 3ec7d65 commit 10adb53

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,16 @@ const payload = {
9292
limit: 2,
9393
offset: 10,
9494
includeApiProjects: false,
95-
order: 'DESC', //possible options: 'DESC', 'ASC'
96-
orderBy: 'order', //possible options: 'order', 'date'
97-
search: '' //get projects with specified title
95+
order: 'DESC', // possible options: 'DESC', 'ASC'
96+
orderBy: 'order', // possible options: 'order', 'date'
97+
search: '' // get projects with specified title
9898
}
9999
renderforest.getProjects(payload)
100100
.then(console.log) // handle the success
101101
.catch(console.error) // handle the error
102102
```
103103
- The renderedQualities property is optional and present if the project is in renders queue (ongoing rend).
104+
- All the properties of `payload` object are optional.
104105

105106
[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/examples/projects/get-projects.js)
106107

0 commit comments

Comments
 (0)