-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
add api docs
1 parent
58de105
commit 06f483c
Showing
5 changed files
with
99 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) | ||
|
||
## API Reference | ||
|
||
## Packages | ||
|
||
| Package | Description | | ||
| --- | --- | | ||
| [@rezasoltani/solid-typeindex-support](./solid-typeindex-support.md) | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@rezasoltani/solid-typeindex-support](./solid-typeindex-support.md) | ||
|
||
## solid-typeindex-support package | ||
|
||
## Classes | ||
|
||
| Class | Description | | ||
| --- | --- | | ||
| [TypeIndexHelper](./solid-typeindex-support.typeindexhelper.md) | | | ||
|
27 changes: 27 additions & 0 deletions
27
docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@rezasoltani/solid-typeindex-support](./solid-typeindex-support.md) > [TypeIndexHelper](./solid-typeindex-support.typeindexhelper.md) > [getFromTypeIndex](./solid-typeindex-support.typeindexhelper.getfromtypeindex.md) | ||
|
||
## TypeIndexHelper.getFromTypeIndex() method | ||
|
||
Retrieves a list of instances from the typeIndex. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate: true): Promise<string[]>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| 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<!-- --><<!-- -->string\[\]<!-- -->><!-- -->} - A promise that resolves to an array of instance URLs. | | ||
|
||
**Returns:** | ||
|
||
Promise<string\[\]> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@rezasoltani/solid-typeindex-support](./solid-typeindex-support.md) > [TypeIndexHelper](./solid-typeindex-support.typeindexhelper.md) | ||
|
||
## TypeIndexHelper class | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare class TypeIndexHelper | ||
``` | ||
|
||
## Methods | ||
|
||
| 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. | | ||
|
29 changes: 29 additions & 0 deletions
29
docs/solid-typeindex-support.typeindexhelper.registerintypeindex.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@rezasoltani/solid-typeindex-support](./solid-typeindex-support.md) > [TypeIndexHelper](./solid-typeindex-support.typeindexhelper.md) > [registerInTypeIndex](./solid-typeindex-support.typeindexhelper.registerintypeindex.md) | ||
|
||
## TypeIndexHelper.registerInTypeIndex() method | ||
|
||
Registers the given webId in the typeIndex. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClass: string, fetch: any, indexUrl: string, isPrivate: boolean): Promise<SolidDataset>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| 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. | | ||
|
||
**Returns:** | ||
|
||
Promise<SolidDataset> | ||
|