laurin
/
ldo-compact-fork
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

@ldo/connected-solid docs

Browse Source
main
Jackson Morgan 5 months ago
parent db87958cb6
commit 425f19e402
4 changed files with 51 additions and 60 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 32
      packages/connected-nextgraph/README.md
  2. 34
      packages/connected-solid/README.md
  3. 1
      packages/connected-solid/typedoc.json
  4. 44
      packages/connected/README.md

32
packages/connected-nextgraph/README.md
Unescape View File

@ -30,9 +30,9 @@ import ng from "nextgraph";
// Open your nextgraph wallet // Open your nextgraph wallet
const openedWallet = await ng.wallet_open_with_mnemonic_words( const openedWallet = await ng.wallet_open_with_mnemonic_words(
wallet.wallet, walletBinary,
mnemonic, mnemonic,
[1, 2, 1, 2] [1, 2, 3, 4]
); );
// Start a session // Start a session
@ -118,28 +118,28 @@ await resource.update({
SolidLdoDataset SolidLdoDataset
- [createSolidLdoDataset](https://ldo.js.org/latest/api/solid/functions/createSolidLdoDataset/) - [createSolidLdoDataset](https://ldo.js.org/latest/api/connected/functions/createSolidLdoDataset/)
- [SolidLdoDataset](https://ldo.js.org/latest/api/solid/classes/SolidLdoDataset/) - [SolidLdoDataset](https://ldo.js.org/latest/api/connected/classes/SolidLdoDataset/)
Resources (Manage batching requests) Resources (Manage batching requests)
- [LeafUri](https://ldo.js.org/latest/api/solid/types/LeafUri/) - [LeafUri](https://ldo.js.org/latest/api/connected/types/LeafUri/)
- [ContainerUri](https://ldo.js.org/latest/api/solid/types/ContainerUri/) - [ContainerUri](https://ldo.js.org/latest/api/connected/types/ContainerUri/)
- [Leaf](https://ldo.js.org/latest/api/solid/classes/Leaf/) - [Leaf](https://ldo.js.org/latest/api/connected/classes/Leaf/)
- [Container](https://ldo.js.org/latest/api/solid/classes/Container/) - [Container](https://ldo.js.org/latest/api/connected/classes/Container/)
Standalone Functions Standalone Functions
- [checkRootContainter](https://ldo.js.org/latest/api/solid/functions/checkRootContainer/) - [checkRootContainter](https://ldo.js.org/latest/api/connected/functions/checkRootContainer/)
- [createDataResource](https://ldo.js.org/latest/api/solid/functions/createDataResource/) - [createDataResource](https://ldo.js.org/latest/api/connected/functions/createDataResource/)
- [deleteResource](https://ldo.js.org/latest/api/solid/functions/deleteResource/) - [deleteResource](https://ldo.js.org/latest/api/connected/functions/deleteResource/)
- [readResource](https://ldo.js.org/latest/api/solid/functions/readResource/) - [readResource](https://ldo.js.org/latest/api/connected/functions/readResource/)
- [updateResource](https://ldo.js.org/latest/api/solid/functions/updateResource/) - [updateResource](https://ldo.js.org/latest/api/connected/functions/updateResource/)
- [uploadResource](https://ldo.js.org/latest/api/solid/functions/uploadResource/) - [uploadResource](https://ldo.js.org/latest/api/connected/functions/uploadResource/)
Data Functions Data Functions
- [changeData](https://ldo.js.org/latest/api/solid/functions/changeData/) - [changeData](https://ldo.js.org/latest/api/connected/functions/changeData/)
- [commitData](https://ldo.js.org/latest/api/solid/functions/commitData/) - [commitData](https://ldo.js.org/latest/api/connected/functions/commitData/)
## Sponsorship ## Sponsorship
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/). This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).

34
packages/connected-solid/README.md
Unescape View File

@ -1,4 +1,4 @@
# @ldo/solid # @ldo/connected-solid
@ldo/solid is a client that implements the Solid specification with the use of Linked Data Objects. @ldo/solid is a client that implements the Solid specification with the use of Linked Data Objects.
@ -10,10 +10,10 @@ cd my_project/
npx run @ldo/cli init npx run @ldo/cli init
``` ```
Now install the @ldo/solid library Now install the @ldo/connected-solid library
``` ```
npm i @ldo/solid npm i @ldo/connected-solid
``` ```
<details> <details>
@ -33,7 +33,8 @@ npm i @ldo/ldo @ldo/solid
Below is a simple example of @ldo/solid. Assume that a ShapeType was previously generated and placed at `./.ldo/foafProfile.shapeTypes`. Also assume we have a shape type for social media at `./.ldo/socialMediaPost.shapeTypes` Below is a simple example of @ldo/solid. Assume that a ShapeType was previously generated and placed at `./.ldo/foafProfile.shapeTypes`. Also assume we have a shape type for social media at `./.ldo/socialMediaPost.shapeTypes`
```typescript ```typescript
import { changeData, commitData, createSolidLdoDataset } from "@ldo/solid"; import { changeData, commitData } from "@ldo/connected";
import { createSolidLdoDataset } from "@ldo/solid";
import { fetch, getDefaultSession } from "@inrupt/solid-client-authn-browser"; import { fetch, getDefaultSession } from "@inrupt/solid-client-authn-browser";
import { FoafProfileShapeType } from "./.ldo/foafProfile.shapeTypes"; import { FoafProfileShapeType } from "./.ldo/foafProfile.shapeTypes";
import { SocialMediaPostShapeType } from "./.ldo/socialMediaPost.shapeTypes"; import { SocialMediaPostShapeType } from "./.ldo/socialMediaPost.shapeTypes";
@ -53,7 +54,8 @@ async function main() {
// SolidLdoDataset. You can think of this dataset as a local store for all the // SolidLdoDataset. You can think of this dataset as a local store for all the
// information in the Solidverse. Don't forget to pass the authenticated fetch // information in the Solidverse. Don't forget to pass the authenticated fetch
// function to do your queries! // function to do your queries!
const solidLdoDataset = createSolidLdoDataset({ fetch }); const solidLdoDataset = createSolidLdoDataset();
solidLdoDataset.setContext({ fetch });
// We'll start with getting a representation of our WebId's resource // We'll start with getting a representation of our WebId's resource
const webIdResource = solidLdoDataset.getResource(webIdUri); const webIdResource = solidLdoDataset.getResource(webIdUri);
@ -206,27 +208,15 @@ main();
SolidLdoDataset SolidLdoDataset
- [createSolidLdoDataset](https://ldo.js.org/latest/api/solid/functions/createSolidLdoDataset/) - [createSolidLdoDataset](https://ldo.js.org/latest/api/solid/functions/createSolidLdoDataset/)
- [SolidLdoDataset](https://ldo.js.org/latest/api/solid/classes/SolidLdoDataset/)
Resources (Manage batching requests) Resources (Manage batching requests)
- [LeafUri](https://ldo.js.org/latest/api/solid/types/LeafUri/) - [SolidResource](https://ldo.js.org/latest/api/classes/SolidResource/)
- [ContainerUri](https://ldo.js.org/latest/api/solid/types/ContainerUri/) - [SolidLeafUri](https://ldo.js.org/latest/api/solid/types/SolidLeafUri/)
- [Leaf](https://ldo.js.org/latest/api/solid/classes/Leaf/) - [SolidContainerUri](https://ldo.js.org/latest/api/solid/types/SolidContainerUri/)
- [Container](https://ldo.js.org/latest/api/solid/classes/Container/) - [SolidLeaf](https://ldo.js.org/latest/api/solid/classes/SolidLeaf/)
- [SolidContainer](https://ldo.js.org/latest/api/solid/classes/SolidContainer/)
Standalone Functions
- [checkRootContainter](https://ldo.js.org/latest/api/solid/functions/checkRootContainer/)
- [createDataResource](https://ldo.js.org/latest/api/solid/functions/createDataResource/)
- [deleteResource](https://ldo.js.org/latest/api/solid/functions/deleteResource/)
- [readResource](https://ldo.js.org/latest/api/solid/functions/readResource/)
- [updateResource](https://ldo.js.org/latest/api/solid/functions/updateResource/)
- [uploadResource](https://ldo.js.org/latest/api/solid/functions/uploadResource/)
Data Functions
- [changeData](https://ldo.js.org/latest/api/solid/functions/changeData/)
- [commitData](https://ldo.js.org/latest/api/solid/functions/commitData/)
## Sponsorship ## Sponsorship
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/). This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).

1
packages/connected-solid/typedoc.json
Unescape View File

@ -1,6 +1,7 @@
{ {
"entryPoints": ["src/index.ts"], "entryPoints": ["src/index.ts"],
"out": "docs", "out": "docs",
"tsconfig": "tsconfig.build.json",
"allReflectionsHaveOwnDocument": true, "allReflectionsHaveOwnDocument": true,
"hideInPageTOC": true, "hideInPageTOC": true,
"hideBreadcrumbs": true, "hideBreadcrumbs": true,

44
packages/connected/README.md
Unescape View File

@ -231,18 +231,18 @@ main();
ConnectedLdoDataset ConnectedLdoDataset
- [createConnectedLdoDataset](https://ldo.js.org/latest/api/connected/functions/createConnectedLdoDataset.md) - [createConnectedLdoDataset](https://ldo.js.org/latest/api/connected/functions/createConnectedLdoDataset/)
- [ConnectedLdoDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoDataset.md) - [ConnectedLdoDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoDataset/)
- [ConnectedLdoTransactionDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoTransactionDataset.md) - [ConnectedLdoTransactionDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoTransactionDataset/)
- [IConnectedLdoDataset](https://ldo.js.org/latest/api/connected/interfaces/IConnectedLdoDataset.md) - [IConnectedLdoDataset](https://ldo.js.org/latest/api/connected/interfaces/IConnectedLdoDataset/)
ConnectedPlugins ConnectedPlugins
- [ConnectedPlugin](https://ldo.js.org/latest/api/connected/interfaces/ConnectedPlugin.md) - [ConnectedPlugin](https://ldo.js.org/latest/api/connected/interfaces/ConnectedPlugin/)
Resources (Manage batching requests) Resources (Manage batching requests)
- [Resource](https://ldo.js.org/latest/api/connected/interfaces/Resource.md) - [Resource](https://ldo.js.org/latest/api/connected/interfaces/Resource/)
Data Functions Data Functions
@ -251,25 +251,25 @@ Data Functions
SuccessResult SuccessResult
- [SuccessResult](https://ldo.js.org/latest/api/connected/classes/SuccessResult.md) - [SuccessResult](https://ldo.js.org/latest/api/connected/classes/SuccessResult/)
- [AbsentReadSuccess](https://ldo.js.org/latest/api/connected/classes/AbsentReadSuccess.md) - [AbsentReadSuccess](https://ldo.js.org/latest/api/connected/classes/AbsentReadSuccess/)
- [AggregateSuccess](https://ldo.js.org/latest/api/connected/classes/AggregateSuccess.md) - [AggregateSuccess](https://ldo.js.org/latest/api/connected/classes/AggregateSuccess/)
- [IgnoredInvalidUpdateSuccess](https://ldo.js.org/latest/api/connected/classes/IgnoredInvalidUpdateSuccess.md) - [IgnoredInvalidUpdateSuccess](https://ldo.js.org/latest/api/connected/classes/IgnoredInvalidUpdateSuccess/)
- [ReadSuccess](https://ldo.js.org/latest/api/connected/classes/ReadSuccess.md) - [ReadSuccess](https://ldo.js.org/latest/api/connected/classes/ReadSuccess/)
- [ResourceSuccess](https://ldo.js.org/latest/api/connected/classes/ResourceSuccess.md) - [ResourceSuccess](https://ldo.js.org/latest/api/connected/classes/ResourceSuccess/)
- [Unfetched](https://ldo.js.org/latest/api/connected/classes/Unfetched.md) - [Unfetched](https://ldo.js.org/latest/api/connected/classes/Unfetched/)
- [UpdateDefaultGraphSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateDefaultGraphSuccess.md) - [UpdateDefaultGraphSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateDefaultGraphSuccess/)
- [UpdateSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateSuccess.md)å - [UpdateSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateSuccess/)å
ErrorResult ErrorResult
- [ErrorResult](https://ldo.js.org/latest/api/connected/classes/ErrorResult.md) - [ErrorResult](https://ldo.js.org/latest/api/connected/classes/ErrorResult/)
- [AggregateError](https://ldo.js.org/latest/api/connected/classes/AggregateError.md) - [AggregateError](https://ldo.js.org/latest/api/connected/classes/AggregateError/)
- [DisconnectedAttemptingReconnectError](https://ldo.js.org/latest/api/connected/classes/DisconnectedAttemptingReconnectError.md) - [DisconnectedAttemptingReconnectError](https://ldo.js.org/latest/api/connected/classes/DisconnectedAttemptingReconnectError/)
- [InvalidUriError](https://ldo.js.org/latest/api/connected/classes/InvalidUriError.md) - [InvalidUriError](https://ldo.js.org/latest/api/connected/classes/InvalidUriError/)
- [ResourceError](https://ldo.js.org/latest/api/connected/classes/ResourceError.md) - [ResourceError](https://ldo.js.org/latest/api/connected/classes/ResourceError/)
- [UnexpectedResourceError](https://ldo.js.org/latest/api/connected/classes/UnexpectedResourceError.md) - [UnexpectedResourceError](https://ldo.js.org/latest/api/connected/classes/UnexpectedResourceError/)
- [UnsupportedNotificationError](https://ldo.js.org/latest/api/connected/classes/UnsupportedNotificationError.md) - [UnsupportedNotificationError](https://ldo.js.org/latest/api/connected/classes/UnsupportedNotificationError/)
## Sponsorship ## Sponsorship
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/). This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).

Write Preview
Loading…
Cancel
Save