Options
All
  • Public
  • Public/Protected
  • All
Menu

Mute-Crypto-Helper

Build Status install size Codacy Badge

Isomorphic API exporting helper functions for mute-crypto project. It is powered by Web Crypto API for the client side and by node-webcrypto-ossl for NodeJS. The documentation can be found here.

Install

npm install @coast-team/mute-crypto-helper

For NodeJS, node-webcrypto-ossl peer dependency is also required.

npm install node-webcrypto-oss

Usage

3 objects are exported by the API: asymmetricCrypto, symmetricCrypto and keyAgreementCrypto.

import { asymmetricCrypto, symmetricCrypto, keyAgreementCrypto } from '@coast-team/mute-crypto-helper'

Or

const { asymmetricCrypto, symmetricCrypto, keyAgreementCrypto } = require('@coast-team/mute-crypto-helper')

Tests

Run the test in a browser:

npm run test

Run the test with NodeJS:

npm run test-node

Generate the documentation

npm run doc

Index

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc