update docs

pondersource · Dec 18, 2023 · cd118c0 · cd118c0
1 parent ea172c1
commit cd118c0
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 16 deletions.
diff --git a/docs/solid-typeindex-support.md b/docs/solid-typeindex-support.md
@@ -8,5 +8,5 @@
 
 |  Class | Description |
 |  --- | --- |
-|  [TypeIndexHelper](./solid-typeindex-support.typeindexhelper.md) |  |
+|  [TypeIndexHelper](./solid-typeindex-support.typeindexhelper.md) | TypeIndexHelper provides helper methods for working with typeIndexes in Solid. This includes methods for getting and updating a user's public and private typeIndexes. |
 
diff --git a/docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md b/docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md
@@ -4,7 +4,7 @@
 
 ## TypeIndexHelper.getFromTypeIndex() method
 
-Retrieves a list of instances from the typeIndex.
+Retrieves all instances of the given RDF class from the user's typeIndexe.
 
 **Signature:**
 
@@ -16,12 +16,14 @@ static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate:
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  webId | string | The WebID of the user. |
-|  rdfClass | string |  |
-|  fetch | any | The authenticated fetch function to use for HTTP requests. |
-|  isPrivate | true | Indicates if the instances are private.  {<!-- -->Promise<!-- -->&lt;<!-- -->string\[\]<!-- -->&gt;<!-- -->} - A promise that resolves to an array of instance URLs. |
+|  webId | string | The user's WebID |
+|  rdfClass | string | The RDF class to retrieve instances for |
+|  fetch | any | Authenticated fetch function |
+|  isPrivate | true | Whether the typeIndexe is private or public |
 
 **Returns:**
 
 Promise&lt;string\[\]&gt;
 
+Promise resolving to an array of instance URLs
+
diff --git a/docs/solid-typeindex-support.typeindexhelper.md b/docs/solid-typeindex-support.typeindexhelper.md
@@ -4,6 +4,8 @@
 
 ## TypeIndexHelper class
 
+TypeIndexHelper provides helper methods for working with typeIndexes in Solid. This includes methods for getting and updating a user's public and private typeIndexes.
+
 **Signature:**
 
 ```typescript
@@ -14,6 +16,6 @@ export declare class TypeIndexHelper
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [getFromTypeIndex(webId, rdfClass, fetch, isPrivate)](./solid-typeindex-support.typeindexhelper.getfromtypeindex.md) | <code>static</code> | Retrieves a list of instances from the typeIndex. |
-|  [registerInTypeIndex(webId, typeRegistrationTitle, rdfClass, fetch, indexUrl, isPrivate)](./solid-typeindex-support.typeindexhelper.registerintypeindex.md) | <code>static</code> | Registers the given webId in the typeIndex. |
+|  [getFromTypeIndex(webId, rdfClass, fetch, isPrivate)](./solid-typeindex-support.typeindexhelper.getfromtypeindex.md) | <code>static</code> | Retrieves all instances of the given RDF class from the user's typeIndexe. |
+|  [registerInTypeIndex(webId, typeRegistrationTitle, rdfClass, fetch, indexUrl, isPrivate)](./solid-typeindex-support.typeindexhelper.registerintypeindex.md) | <code>static</code> | Registers a type registration in the user's typeIndexe. |
 
diff --git a/docs/solid-typeindex-support.typeindexhelper.registerintypeindex.md b/docs/solid-typeindex-support.typeindexhelper.registerintypeindex.md
@@ -4,7 +4,7 @@
 
 ## TypeIndexHelper.registerInTypeIndex() method
 
-Registers the given webId in the typeIndex.
+Registers a type registration in the user's typeIndexe.
 
 **Signature:**
 
@@ -16,14 +16,16 @@ static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClas
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  webId | string | The WebID of the user. |
-|  typeRegistrationTitle | string |  |
-|  rdfClass | string |  |
-|  fetch | any | The authenticated fetch function to use for HTTP requests. |
-|  indexUrl | string | The URL of the typeIndex. |
-|  isPrivate | boolean | Flag indicating if the typeIndex is private.  {<!-- -->Promise<SolidDataset>} The updated typeIndex dataset. |
+|  webId | string | The WebID of the user |
+|  typeRegistrationTitle | string | The title to use for the type registration |
+|  rdfClass | string | The RDF class that this registration is for |
+|  fetch | any | The authenticated fetch function |
+|  indexUrl | string | The URL of the index being registered |
+|  isPrivate | boolean | Whether to register in the private or public typeIndexe |
 
 **Returns:**
 
 Promise&lt;SolidDataset&gt;
 
+A Promise resolving to the updated typeIndexe dataset
+
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     "clean": "rimraf dist/",
     "build": "npm run clean && tsc",
     "api-report": "api-extractor run",
-    "api-docs": "api-documenter markdown -i temo -o docs",
+    "api-docs": "api-documenter markdown -i temp -o docs",
     "build-with-docs": "npm run build && npm run api-report && npm run api-docs",  
     "test": "jest"
   },