update docs

pondersource · Dec 28, 2023 · df6335a · df6335a
1 parent 05d3b62
commit df6335a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md b/docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md
@@ -9,7 +9,10 @@ Retrieves all instances of the given RDF class from the user's typeIndexe.
 **Signature:**
 
 ```typescript
-static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate: boolean): Promise<string[]>;
+static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate: boolean): Promise<{
+        instanceContainers: string[];
+        instances: string[];
+    }>;
 ```
 
 ## Parameters
@@ -23,7 +26,7 @@ static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate:
 
 **Returns:**
 
-Promise&lt;string\[\]&gt;
+Promise&lt;{ instanceContainers: string\[\]; instances: string\[\]; }&gt;
 
-Promise resolving to an array of instance URLs
+Promise resolving to an object containing instance URLs and instanceContainers URLs.
 
diff --git a/etc/solid-typeindex-support.api.md b/etc/solid-typeindex-support.api.md
@@ -8,7 +8,10 @@ import { SolidDataset } from '@inrupt/solid-client';
 
 // @public
 export class TypeIndexHelper {
-    static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate: boolean): Promise<string[]>;
+    static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate: boolean): Promise<{
+        instanceContainers: string[];
+        instances: string[];
+    }>;
     static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClass: string, fetch: any, solidInstanceUrl: string, isPrivate: boolean): Promise<SolidDataset>;
 }