Skip to content

Commit

Permalink
documented completeHomework()
Browse files Browse the repository at this point in the history
  • Loading branch information
chopster44 committed Mar 25, 2023
1 parent ffc4f8b commit 22dda7a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,12 @@ The function `getPastHomework()`, returns all past homework in the type `Homewor
```ts
await edulink.getHomeworkDescription({id: "12345", source: "Edulink"});
```
The function `getHomeworkDescription()`, takes the `id` of the homework and `"Edulink"` as the source(*)
The function `getHomeworkDescription()`, takes the `id` of the homework and `"Edulink"` as the source(*).

```ts
await edulink.completeHomework({id: "12345", completed: true});
```
The function `completeHomework()`, takes the `id` of the homework and if it is `completed` as a boolean.

## Other info
(*) - if this symbol is used then the functionality of the feature being talked about is not fully known.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "edulinkone-api",
"version": "1.1.4",
"version": "1.1.5",
"description": "A custom-built unofficial api for OvernetData's Edulinkone",
"homepage": "https://github.com/chopster44/edulinkone-api#readme",
"bugs": {
Expand Down

0 comments on commit 22dda7a

Please sign in to comment.