@evervault/sdk

evervault node sdk

The Node.js SDK for working with evervault cages.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Setup
• API Reference
  • evervaultClient.encrypt
  • evervaultClient.run
  • evervaultClient.encryptAndRun
  • Encryption Options

Getting Started

Prerequisites

To get started with the evervault Node.js SDK, you will need to have created a team on the evervault dashboard.

We are currently in invite-only early access. You can apply for early access here.

Installation

npm install --save @evervault/sdk

yarn add @evervault/sdk

Setup

const Evervault = require('@evervault/sdk');

// Initialize the client with your team's api key
const evervaultClient = new Evervault(<API-KEY>);

// Encrypt your data and run a cage
const result = await evervaultClient.encryptAndRun(<CAGE-NAME>, { hello: 'World!' });

API Reference

evervaultClient.encrypt

Encrypt lets you encrypt data for use in any of your evervault cages. You can use it to store encrypted data to be used in a cage at another time.

async evervaultClient.encrypt(data: Object | String, options?: Object);

Parameter	Type	Description
data	Object or String	Data to be encrypted
options	Object	Standard evervault encryption options

evervaultClient.run

Run lets you invoke your evervault cages with a given payload.

async evervaultClient.run(cageName: String, payload: Object);

Parameter	Type	Description
cageName	String	Name of the cage to be run
data	Object	Payload for the cage

evervaultClient.encryptAndRun

Encrypt your data and use it as the payload to invoke the cage.

async evervaultClient.encryptAndRun(cageName: String, data: Object, options: Object);

Parameter	Type	Description
cageName	String	Name of the cage to be run
data	Object	Data to be encrypted
options	Object	Standard evervault encryption options

Encryption Options

Options to control how your data is encrypted.

Option	Default	Description
fieldsToEncrypt	All keys	If the data is an object, fieldsToEncrypt specifies the keys to encrypt.