Function query

query(
    queryEndpoint: string,
    vpRequest: VerifiablePresentationRequest,
    options: ParseOptions & {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld: false;
    },
): Promise<MinimalPresentation>
Send a Verifiable Presentation Request to a query endpoint in order to retrieve all Verifiable Credentials matching the query, wrapped in a single Presentation.
Parameters
- queryEndpoint: string
  URL of the query endpoint.
- vpRequest: VerifiablePresentationRequest
  VP Request object, compliant with https://w3c-ccg.github.io/vp-request-spec
- options: ParseOptions & {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld: false;
  }
  Options object, including an authenticated fetch.
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase
  - returnLegacyJsonld: false
Returns Promise<MinimalPresentation>
The resulting Verifiable Presentation wrapping all the Credentials matching the query.
Example: The following shows how to query for credentials of a certain type. Adding
a reason to the request is helpful when interacting with a user. The resulting Verifiable Presentation will wrap zero or more Verifiable Credentials.
```
const verifiablePresentation = await query(
   "https://example.org/query", {
     query: [{
       type: "QueryByExample",
       credentialQuery: [
         {
           reason: "Some reason",
           example: {
             type: ["SomeCredentialType"],
           },
         },
       ],
     }]
   },
   { fetch: session.fetch }
 );
```
Deprecated
This function will be removed in future versions. No replacement is planned.
- Defined in lookup/query.ts:124
query(
    queryEndpoint: string,
    vpRequest: VerifiablePresentationRequest,
    options?: ParseOptions & {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld?: true;
    },
): Promise<ParsedVerifiablePresentation>
Parameters
- queryEndpoint: string
- vpRequest: VerifiablePresentationRequest
- Optionaloptions: ParseOptions & {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld?: true;
  }
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase
  - OptionalreturnLegacyJsonld?: true
Returns Promise<ParsedVerifiablePresentation>

Deprecated
Use RDFJS API instead of relying on the JSON structure by setting returnLegacyJsonld to false
- Defined in lookup/query.ts:136
query(
    queryEndpoint: string,
    vpRequest: VerifiablePresentationRequest,
    options?: ParseOptions & {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld?: boolean;
    },
): Promise<ParsedVerifiablePresentation | MinimalPresentation>
Parameters
- queryEndpoint: string
- vpRequest: VerifiablePresentationRequest
- Optionaloptions: ParseOptions & {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld?: boolean;
  }
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase
  - OptionalreturnLegacyJsonld?: boolean
Returns Promise<ParsedVerifiablePresentation | MinimalPresentation>

Deprecated
Use RDFJS API instead of relying on the JSON structure by setting returnLegacyJsonld to false
- Defined in lookup/query.ts:148

Function query

Parameters

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

`Optional`normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

returnLegacyJsonld: false

Returns Promise<MinimalPresentation>

Example: The following shows how to query for credentials of a certain type. Adding

Deprecated

Parameters

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

`Optional`normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: true

Returns Promise<ParsedVerifiablePresentation>

Deprecated

Parameters

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

`Optional`normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: boolean

Returns Promise<ParsedVerifiablePresentation | MinimalPresentation>

Deprecated

Settings

Function query

Parameters

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

Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

returnLegacyJsonld: false

Returns Promise<MinimalPresentation>

Example: The following shows how to query for credentials of a certain type. Adding

Deprecated

Parameters

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

Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

OptionalreturnLegacyJsonld?: true

Returns Promise<ParsedVerifiablePresentation>

Deprecated

Parameters

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

Optionalnormalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

OptionalreturnLegacyJsonld?: boolean

Returns Promise<ParsedVerifiablePresentation | MinimalPresentation>

Deprecated

Settings

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

`Optional`normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

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

`Optional`normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: true

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

`Optional`normalize?: (vc: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: boolean