Functions to flatten and unflatten nested JavaScript objects into a single level. Keys are enumerated if they collide.
The code is documented using tsdoc. The tests are helpful to read as well. There are also docs generated using api-extractor in the docs folder.
To run:
npm startThis builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.
To do a one-off build, use npm run build.
To run tests, use npm test.
Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.
Jest tests are set up to run with npm test.
size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.
Two actions are added by default:
mainwhich installs deps w/ cache, lints, tests, checks size and builds on all pushes against a Node and OS matrix