Function fetchWithVc

fetchWithVc(
    resourceIri: string,
    accessGrant: VerifiableCredential | DatasetWithId,
    options?: FetchOptions,
): Promise<
    {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    },
>
Builds a WHATWG Fetch compatible function issuing authenticated requests based on an Access Grant VC. The obtained fetch function authentication will only be valid for the resources included in the Access Grant.

Note that providing an authenticated fetch as an option is mandatory for the resulting fetch to be valid. The input fetch should be authenticated to the requestor's Solid-OIDC provider.
Parameters
- resourceIri: string
  One of the resources from the Access Grant.
- accessGrant: VerifiableCredential | DatasetWithId
  The Verifiable Credential proving that the requestor has been granted access to the target resource.
- Optionaloptions: FetchOptions
  Additional fetch options, allowing you to override the fetch() implementation
Returns Promise<
    {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    },
>
A Promise resolving to a WHATWG Fetch compatible function matching the standard signature. The obtained fetch function will override any provided Authentication header with authentication information obtained thanks to the provided VC.

Since
0.4.0
- Defined in src/fetch/index.ts:164

Function fetchWithVc

Parameters

Returns Promise< { (input: URL | RequestInfo, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; },>

Since

Settings

Returns Promise<
{
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
},
>