Skip to content

Commit

Permalink
Update README.md to match code (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
michielbdejong authored Jan 26, 2024
1 parent f20f7d1 commit 6516d42
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
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

0 comments on commit 6516d42

Please sign in to comment.