Improve documenation for quickly using this as a wrapper for other date libraries about date-io HOT 2 OPEN

// my-awesome-lib

// Choose which adapters library will support, and re-export them
export { default as dateFnsAdapter } from '@date-io/date-fns';
export { default as dayJsAdapter } from '@date-io/dayjs';
export { default as luxonAdapter } from '@date-io/luxon';

// Export new library code
export default class AwesomeLib {
    MyAdapter; // Will be one of the adapters above, which all have common interface

    // Adapter will be supplied by user of my-awesome-lib
    constructor(adapter) {
        this.MyAdapter = adapter;
    }

    function add5DaysAndFormat(theDate) {
        // Perform the following actions using the common adapter interface:
        //  - Create a new date instance
        //  - Manipulate the date (add 5 days)
        //  - Format the date (using one of the preset formats)
        const myDate = this.MyAdapter.date(theDate);
        const myDatePlus5 = this.MyAdapter.addDays(myDate, 5);
        const formattedResult = this.MyAdapter.format(myDatePlus5, 'fullDate');

        // Return the resulting string
        return formattedResult;
    }
}

// someone-using-my-awesome-lib
import dayjs from 'dayjs';

// They import your library, and the adapter that matches their own date library
import AwesomeLib, { dayJsAdapter } from 'my-awesome-lib';
const awesomeInstance = new AwesomeLib(new dayJsAdapter());

// They can use your library via the adapter they chose
const tomorrow = dayjs().add(1, 'day').toDate(); // JS Date via dayjs - eg. Sat Oct 22 2022 13:31:50 GMT-600
const tomorrowPlus5 = awesomeInstance.add5DaysAndFormat(tomorrow); // String via your lib - Oct 27, 2022

// someone-using-my-awesome-lib
import { addDays } from 'date-fns';

// They import your library, and the adapter that matches their own date library
import AwesomeLib, { dateFnsAdapter } from 'my-awesome-lib';
const awesomeInstance = new AwesomeLib(new dateFnsAdapter());

// They can use your library via the adapter they chose
const tomorrow = addDays(new Date(), 1); // JS Date via date-fns - eg. Sat Oct 22 2022 13:31:50 GMT-600
const tomorrowPlus5 = awesomeInstance.add5DaysAndFormat(tomorrow); // String via your lib - Oct 27, 2022