diff --git a/README.md b/README.md index ae55a57..cbb6730 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,13 @@ npm run build ### getTypeIndexFromProfile Finds the URL of one of the type indexes, given the URL of the profile document. Returns a string or throws an error, namely: + FIXME: Complete this list and create a unit test for each of them, ref https://github.com/pondersource/soukai-solid-utils/issues/17 -If the webId URL is malformed then ... -If the profile document cannot be retrieved, then ... -If fetching the profile document times out based on the timeout of the Fetch function (?), then ... -If the profile document is not valid JSON-LD then ... -If the profile document does not contain a link to a type index of the requested type then ... +* If the webId URL is malformed then ... +* If the profile document cannot be retrieved, then ... +* If fetching the profile document times out based on the timeout of the Fetch function (?), then ... +* If the profile document is not valid JSON-LD then ... +* If the profile document does not contain a link to a type index of the requested type then ... Example usage: ``` @@ -28,4 +29,4 @@ const args = { }; const result = await getTypeIndexFromProfile(args as any); expect(result).toBe("https://michielbdejong.solidcommunity.net/settings/publicTypeIndex.ttl"); -``` \ No newline at end of file +```