README

image-to-totp

image-to-totp is a library to generate totp codes from a QR code image with a single API.

Usage

npm install @thomaschaplin/image-to-totp

Example Usage

Find full example here but see the below code snippet

src/
  images/
    example1.png
    example2.png

import { imageToTotp } from "@thomaschaplin/image-to-totp";
import * as path from "path";

const example = async (account: string) => {
  const projectBaseFolder = path.join(__dirname, "../");
  const imagesFolder = path.join(projectBaseFolder, "src/images");
  const totp = await imageToTotp(`${imagesFolder}/${account}.png`);
  console.log(`Account: ${account} - ${totp}`);
};

example("example1"); // Account: example1 - 034624
example("example2"); // Account: example2 - 084841

Description

This repository allows you to take a QR code image and turn it into a TOTP code.

This project uses:

Setup

Make sure you have Node.js installed on your machine

Development

Installation

Clone this repository git clone git@github.com:thomaschaplin/image-to-totp.git
Change directory cd image-to-totp
Install the dependencies npm install
Transpile the code npm run build or npm run watch

Tests

Run the tests npm test
Run the tests with coverage npm run test:coverage
Run the tests with mutation testing npm run test:mutation

Image by mohamed Hassan from Pixabay

Usage no npm install needed!