Skip to content

Commit

Permalink
update return types in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
soltanireza65 committed Nov 29, 2023
1 parent 547261c commit 47104cb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions bookmarks/vanilla/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ They will return a promise containing the JSON representation of the bookmark
import { Session } from "@inrupt/solid-client-authn-browser";

const result: IBookmark[] = await Bookmarks.getAll(session: Session);
const result: IBookmark = await Bookmarks.get("<pk>", session: Session);
const result: IBookmark | undefined = await Bookmarks.get("<pk>", session: Session);
const result: boolean = await Bookmarks.delete("<pk>", session: Session);
const result: boolean = await Bookmarks.create(payload: ICreateBookmark, session: Session);
const result: IBookmark = await Bookmarks.update("<pk>", payload: IUpdateBookmark, session: Session);
const result: IBookmark | undefined = await Bookmarks.update("<pk>", payload: IUpdateBookmark, session: Session);
```

- pk indicates the primary key of the bookmark, in this case its the url of the bookmark
Expand Down

0 comments on commit 47104cb

Please sign in to comment.