@credo-ts/question-answer
TypeScript icon, indicating that this package has built-in type declarations

0.5.3 • Public • Published


Credo Logo

Credo Question Answer Module

License typescript @credo-ts/question-answer version


Question Answer module for Credo. Implements Aries RFC 0113.

Quick start

In order for this module to work, we have to inject it into the agent to access agent functionality. See the example for more information.

Example of usage

import { QuestionAnswerModule } from '@credo-ts/question-answer'

const agent = new Agent({
  config: {
    /* config */
  },
  dependencies: agentDependencies,
  modules: {
    questionAnswer: new QuestionAnswerModule(),
    /* other custom modules */
  },
})

await agent.initialize()

// To send a question to a given connection
await agent.modules.questionAnswer.sendQuestion(connectionId, {
  question: 'Do you want to play?',
  validResponses: [{ text: 'Yes' }, { text: 'No' }],
})

// Questions and Answers are received as QuestionAnswerStateChangedEvent

// To send an answer related to a given question answer record
await agent.modules.questionAnswer.sendAnswer(questionAnswerRecordId, 'Yes')

Readme

Keywords

none

Package Sidebar

Install

npm i @credo-ts/question-answer

Weekly Downloads

1,033

Version

0.5.3

License

Apache-2.0

Unpacked Size

78.1 kB

Total Files

60

Last publish

Collaborators

  • openwalletfoundation
  • timoglastra