Détail du package

Can I email… - Fetcher

An easy to use npm package to integrate the up to date data from the Can I email… project.
Explore the docs »

Report Bug · Request Feature

About The Project

coming soon...

(back to top)

Built With

(back to top)

Getting Started

Installation

1. Install NPM package

    npm i caniemail-fetcher
   

(back to top)

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);

(back to top)

Top contributors:

(back to top)

License

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

(back to top)

Contact

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

(back to top)

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.

(back to top)