Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation for getJobs() #1468

Merged
merged 3 commits into from Mar 21, 2020
Merged

Improve documentation for getJobs() #1468

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f8a51a
Improve documentation for getJobs()
soulchild Sep 12, 2019
5c52ea3
Merge pull request #1 from soulchild/soulchild-fix-for-1454
soulchild Sep 12, 2019
57ee8d2
Fix typo in docs
soulchild Sep 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions REFERENCE.md
View file
Open in desktop
Expand Up @@ -412,7 +412,9 @@ parameter. If the specified job cannot be located, the promise will be resolved
getJobs(types: string[], start?: number, end?: number, asc?: boolean): Promise<Job[]>
```

Returns a promise that will return an array of job instances of the given types. Optional parameters for range and ordering are provided.
Returns a promise that will return an array of job instances of the given types. Optional parameters for range and ordering are provided.

Note: The `start` and `end` options are applied **per job type**. For example, if there are 10 jobs in state `completed` and 10 jobs in state `active`, `getJobs(['completed', 'active'], 0, 4)` will yield an array with 10 entries, representing the first 5 completed jobs (0 - 4) and the first 5 active jobs (0 - 4).

---

Expand All @@ -425,7 +427,7 @@ getJobLogs(jobId: string, start?: number, end?: number): Promise<{
}>
```

Returns a object with the logs according to the stard and end arguments. The returned count
Returns a object with the logs according to the start and end arguments. The returned count
value is the total amount of logs, useful for implementing pagination.

---
Expand Down