Skip to content

Commit b2d9a6c

Browse files
docs: add detentions example (thanks @Jazzrox12)
1 parent 468b436 commit b2d9a6c

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ contributing! If you have any questions, feel free to ask in the
4343

4444
## Requirements
4545

46-
- Node.js 18 or newer
47-
\
46+
- Node.js 18 or newer\
4847
OR
4948
- Deno
5049

@@ -293,6 +292,23 @@ Gets all detentions.
293292
```typescript
294293
const detentions = await client.getDetentions();
295294
console.log(detentions);
295+
296+
/**
297+
{
298+
"success": 1,
299+
"data": [
300+
{
301+
"id": 12345678,
302+
"attended": "no",
303+
"date": "2024-03-28T00:00:00+00:00",
304+
...
305+
}
306+
],
307+
"meta": {
308+
"detention_alias_plural": "detentions"
309+
}
310+
}
311+
*/
296312
```
297313

298314
## `.getAttendance`
@@ -343,4 +359,4 @@ Changes the parent's password.
343359

344360
```typescript
345361
await client.changePassword("oldPassword", "newPassword");
346-
```
362+
```

0 commit comments

Comments
 (0)