fix: improve docs

input-output-hk · Apr 17, 2024 · 6594cab · 6594cab
1 parent 8ed69f7
commit 6594cab
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/prism-agent/Agent.ts b/src/prism-agent/Agent.ts
@@ -526,6 +526,15 @@ export default class Agent
    * @param {Domain.DID} toDID 
    * @param {ProofTypes[]} proofTypes[]
    * @returns 
+   * 
+   * Example usecase: Send a Presentation Request to a specific PeerDID for a Credential issued by a specific issuer
+   * ```ts
+   *  agent.initiatePresentationRequest(
+   *    Domain.CredentialType.JWT,
+   *    toDID,
+   *    { issuer: Domain.DID.fromString("did:peer:12345"), claims: {email: 'test@test.com'}}
+   * );
+   * ```
    */
   async initiatePresentationRequest(type: Domain.CredentialType, toDID: Domain.DID, presentationClaims: Domain.PresentationClaims): Promise<RequestPresentation> {
     const requestPresentation = await this.agentCredentials.initiatePresentationRequest(