1.0.7 • Published 7 months ago

caniemail-fetcher v1.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Contributors Forks Stargazers Issues MIT License

About The Project

Product Name Screen Shot

coming soon...

Built With

  • Typescript
  • Bun

Getting Started

Installation

  1. Install NPM package
    npm i caniemail-fetcher

Usage

import { CanIEmailFetcher } from 'caniemail-fetcher';

// Optional settings
const options = {
    githubToken: 'YOUR_GITHUB_TOKEN', // Optional, removes GitHub API rate limit
    updateInterval: 12, // Optional, interval to check for updates in hours, default is 24
};

const fetcher = new CanIEmailFetcher(options);

// Update Listener
const updateListener = (data) => {
    console.log('Update event received', data);
};

// Listen for updates
fetcher.onUpdate(updateListener);

// Stop listening for updates
fetcher.offUpdate(updateListener);

Top contributors:

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/FabianKrup/caniemail-fetcher

Acknowledgments

This project makes extensive use of the data provided by the Can I email… project. We are deeply grateful for their hard work and dedication to improving email standards and compatibility across different platforms. Their project serves as the foundation upon which our tool builds to provide up-to-date email client compatibility information.