@inrupt/solid-client-vc
    Preparing search index...

    Function getVerifiableCredentialAllFromShape

    • Look up VCs from a given holder according to a subset of their claims, such as the VC type, or any property associated to the subject in the VC. The holder is expected to implement the W3C VC Holder HTTP API.

      Parameters

      • holderEndpoint: string

        The /derive endpoint of the holder.

      • vcShape: Partial<VerifiableCredentialBase>

        The subset of claims you expect the matching VCs to contain.

      • options: {
            fetch?: {
                (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
                (input: string | Request | URL, init?: RequestInit): Promise<Response>;
            };
            includeExpiredVc?: boolean;
            returnLegacyJsonld: false;
        }

        Optional parameter:

        • options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API. This can be typically used for authentication. Note that if it is omitted, and @inrupt/solid-client-authn-browser is in your dependencies, the default session is picked up.
        • options.includeExpiredVc: include expired VC matching the shape in the result set.
        • options.returnLegacyJsonld: : Include the normalized JSON-LD in the response
        • Optionalfetch?: {
              (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
              (input: string | Request | URL, init?: RequestInit): Promise<Response>;
          }
        • OptionalincludeExpiredVc?: boolean
        • returnLegacyJsonld: false

      Returns Promise<DatasetWithId[]>

      A list of VCs matching the given VC shape. The list may be empty if the holder does not hold any matching VC.

      0.1.0

      This function will be removed in future versions. No replacement is planned.

    • Look up VCs from a given holder according to a subset of their claims, such as the VC type, or any property associated to the subject in the VC. The holder is expected to implement the W3C VC Holder HTTP API.

      Parameters

      • holderEndpoint: string

        The /derive endpoint of the holder.

      • vcShape: Partial<VerifiableCredentialBase>

        The subset of claims you expect the matching VCs to contain.

      • Optionaloptions: {
            fetch?: {
                (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
                (input: string | Request | URL, init?: RequestInit): Promise<Response>;
            };
            includeExpiredVc?: boolean;
            normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
            returnLegacyJsonld?: true;
        }

        Optional parameter:

        • options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API. This can be typically used for authentication. Note that if it is omitted, and @inrupt/solid-client-authn-browser is in your dependencies, the default session is picked up.
        • options.includeExpiredVc: include expired VC matching the shape in the result set.
        • options.returnLegacyJsonld: : Include the normalized JSON-LD in the response
        • Optionalfetch?: {
              (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
              (input: string | Request | URL, init?: RequestInit): Promise<Response>;
          }
        • OptionalincludeExpiredVc?: boolean
        • Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase
        • OptionalreturnLegacyJsonld?: true

      Returns Promise<VerifiableCredential[]>

      A list of VCs matching the given VC shape. The list may be empty if the holder does not hold any matching VC.

      0.1.0

      Deprecated in favour of setting returnLegacyJsonld: false. This will be the default value in future versions of this library.

    • Look up VCs from a given holder according to a subset of their claims, such as the VC type, or any property associated to the subject in the VC. The holder is expected to implement the W3C VC Holder HTTP API.

      Parameters

      • holderEndpoint: string

        The /derive endpoint of the holder.

      • vcShape: Partial<VerifiableCredentialBase>

        The subset of claims you expect the matching VCs to contain.

      • Optionaloptions: {
            fetch?: {
                (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
                (input: string | Request | URL, init?: RequestInit): Promise<Response>;
            };
            includeExpiredVc?: boolean;
            normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
            returnLegacyJsonld?: boolean;
        }

        Optional parameter:

        • options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API. This can be typically used for authentication. Note that if it is omitted, and @inrupt/solid-client-authn-browser is in your dependencies, the default session is picked up.
        • options.includeExpiredVc: include expired VC matching the shape in the result set.
        • options.returnLegacyJsonld: : Include the normalized JSON-LD in the response
        • Optionalfetch?: {
              (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
              (input: string | Request | URL, init?: RequestInit): Promise<Response>;
          }
        • OptionalincludeExpiredVc?: boolean
        • Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase
        • OptionalreturnLegacyJsonld?: boolean

      Returns Promise<DatasetWithId[]>

      A list of VCs matching the given VC shape. The list may be empty if the holder does not hold any matching VC.

      0.1.0

      Deprecated in favour of setting returnLegacyJsonld: false. This will be the default value in future versions of this library.

    Settings
    Member Visibility