https://github.com/dvcrn/maskedemail-js

JS wrapper for FastMail's MaskedEmail
https://github.com/dvcrn/maskedemail-js

Last synced: 6 days ago
JSON representation

JS wrapper for FastMail's MaskedEmail

• Host: GitHub
• URL: https://github.com/dvcrn/maskedemail-js
• Owner: dvcrn
• Created: 2022-09-25T05:21:57.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T23:50:47.000Z (over 1 year ago)
• Last Synced: 2024-09-23T01:53:15.549Z (about 1 month ago)
• Language: JavaScript
• Size: 196 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FastMail maskedemail JS SDK

JavaScript wrapper / SDK for interacting with FastMail's MaskedEmail service

This is based off my [maskedemail-cli](https://github.com/dvcrn/maskedemail-cli)

## Install

```

yarn add maskedemail

-- or -- 

node i maskedemail

```

## Notes before using

Instead of implementing the API in JavaScript, this package compiles [maskedemail-cli](https://github.com/dvcrn/maskedemail-cli) to WASM, then executes that. The WASM is pretty unoptimized and rocks a whopping 7MB+ in file size :D 

Why?? Because I wanted to play around with WASM, and didn't want to duplicate the code again.

There is a [gopherjs](https://github.com/gopherjs/gopherjs) fallback if WebAssembly is not available. Both gopherjs and wasm builds are pretty chunky in file size so probably not a good idea to use this on the browser.

## Usage

Follow the "authentication" steps over at https://github.com/dvcrn/maskedemail-cli#authentication

```ts

import { list, create } from "maskedemail";

const token = "fastmailToken";

const accID = "fastmailAccID";

(async () => {

  const pr = await list(token, accID);

  console.log(pr);

  console.log("creating new");

  const created = await create(token, accID, "test.com");

  console.log(created);

})().catch((err) => {

  console.error(err);

});

```

### Using gopherjs mode instead

```ts

import { init, list, create } from "maskedemail";

const token = "fastmailToken";

const accID = "fastmailAccID";

(async () => {

  await init('gopherjs');

  const sess = await session(token);

  console.log(sess);

})().catch((err) => {

  console.error(err);

});

```

## Building

Requirements:

- gopherjs (https://github.com/gopherjs/gopherjs)

- rollup (`npm install --global rollup`)

Make sure to run `yarn` to install all the dependencies

Run `make build` to build both wasm and gopherjs variants, and bundle with rollup

## License

MIT