@inrupt/solid-client / profile/webid

Module: profile/webid

Table of contents

Type aliases

Functions

Type aliases

ProfileAll

Ƭ ProfileAll<T>: Object

Type parameters

Name

Type

T

extends SolidDataset & WithServerResourceInfo

Type declaration

Name

Type

altProfileAll

SolidDataset & WithServerResourceInfo[]

webIdProfile

T

Defined in

src/profile/webid.ts:38

Functions

getProfileAll

getProfileAll<T>(webId, options?): Promise<ProfileAll<T>>

Get all the Profile Resources discoverable from a WebID Profile.

A WebID Profile may be any RDF resource on the Web, it doesn’t have to be a Solid resource. That is why, in order to expose a Solid-enabled part of their profile, some WebID profiles link to a Profile Resource, which may be a Solid resource.

since 1.16.0

Type parameters

Name

Type

T

extends Readonly<Object> & WithResourceInfo & { }

Parameters

Name

Type

Description

webId

WebId

WebID of the agent you want the profile of.

options

Partial<typeof internal_defaultFetchOptions & { webIdProfile: T }>

Optional parameter - options.webIdProfile: The data retrieved when looking up the WebID. This will be fetched if not provided. - options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API.

Returns

Promise<ProfileAll<T>>

Promise resolving to an array of SolidDataset, each corresponding to a personal profile document discoverable from the WebID Profile Document. If none are found, the WebID profile document itself is returned.

Defined in

src/profile/webid.ts:62