Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 726 Bytes

README.md

File metadata and controls

23 lines (16 loc) · 726 Bytes

Message Receipts extension module for Aries Framework JavaScript

This module is used to provide an Aries Agent built with Aries Framework JavaScript means to manage Message Receipts protocol.

It's conceived as an extension module for Aries Framework JavaScript which can be injected to an existing agent instance:

import { ReceiptsModule } from 'credo-ts-receipts'

const agent = new Agent({
  config: {
    /* agent config */
  },
  dependencies,
  modules: { receipts: new ReceiptsModule() },
})

Once instantiated, media module API can be accessed under agent.modules.receipts namespace

Usage

TODO