v2.3.1 Api & Documentation Improvements

This was really existing time that get results in many PR merged 🚀

Important Note:

Some functions and default exports was refactored, it means that the previous version is deprecated now. It still works same way like previous, however it will be removed on January 2021. Please follow by deprecated notes or use Migration Guide

Change List

Refactoring:

• IMPORTANT: Obsolete default exports (#27)
• IMPORTANT: Rename class members to cameCase (#28) - and obsolete older in PascalCase
• Add default mapper to Importer (#19) - Many thanks for @lowkeypriority
• Refactoring and clean up performed (#20)
  • Introduce strategies
  • Introduce enum ImportType
• Introduce type ValueMapper, (#29)

Security:

• Handling incorrect type param value more explicitly. (#20)

Documentation:

• Describe configuration options (#20)
• Added supported node versions: 7fd63b4
• Some minor changes

Migration Guide:

1. First rename all GetAllItems to getAllItems. Run test to prove that it doesn't fail your up.
2. Rename all From to from, run test again.
3. Change default imports to specific:

from: const ImporterFactory = require('xlsx-import/lib/ImporterFactory').default;
to: const {ImporterFactory} = require('xlsx-import/lib/ImporterFactory');

from: import ImporterFactory from 'xlsx-import/lib/ImporterFactory';
to: import {ImporterFactory} from 'xlsx-import/lib/ImporterFactory';

4. run test

Migration is required to proceed before January 2021, when deprecated items will be removed.

Upgrade version and resolving deprecations was done also in our sample, this PR #33 might be helpful for you.

---

Do you want to support my work? ❤️ Sponsor me
Your issue is stuck? I can make it done, contact me for further info :)