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

Update README.md to match code #5

Merged
merged 1 commit into from
Jan 26, 2024
Merged

Update README.md to match code #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ const updatedIndex = await TypeIndexHelper.registerInTypeIndex(webId, 'My Book L

| Method | Modifiers | Description |
| --- | --- | --- |
| getFromTypeIndex(webId, rdfClass, fetch, isPrivate) | <code>static</code> | Retrieves all instances of the given RDF class from the user's typeIndexe. |
| registerInTypeIndex(webId, typeRegistrationTitle, rdfClass, fetch, solidInstanceUrl, isPrivate) | <code>static</code> | Registers a type registration in the user's typeIndexe. |
| getFromTypeIndex(webId, rdfClass, fetch, isContainer, isPrivate) | <code>static</code> | Retrieves all instances of the given RDF class from one of the user's typeIndexes. |
| registerInTypeIndex(webId, typeRegistrationTitle, rdfClass, fetch, solidInstanceUrl, isPrivate) | <code>static</code> | Registers a type registration in one of the user's typeIndexes. |



Expand Down Expand Up @@ -95,10 +95,11 @@ static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClas
| rdfClass | string | The RDF class that this registration is for |
| fetch | any | The authenticated fetch function |
| solidInstanceUrl | string | The URL of the index being registered |
| isContainer | boolean | Whether to register a `solid:instanceContainer` or a `solid:instance` |
| isPrivate | boolean | Whether to register in the private or public typeIndexe |

**Returns:**

Promise&lt;SolidDataset&gt;

A Promise resolving to the updated typeIndexe dataset
A Promise resolving to the updated typeIndexe dataset
Loading