npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

enmap

5.1.2 • Public • Published

Enmap - Enhanced Maps

Discord server NPM version NPM downloads Dependencies Patreon

npm installnfo

Enhanced Maps are a data structure that can be used to store data in memory that can also be saved in a database behind the scenes. These operations are fast, safe, and painless.

The data is synchronized to the database automatically, seamlessly, and asynchronously for maximum effectiveness. The storage system used is an sqlite database which is fast, performant, can be easily backed up, and supports multiple simultaneous connections.

UPDATE 5.0 : Please take note that from Enmap 5.0 I am reverting my emphasis on the idea that enmap is scalable. It's not, and I can't make it better. I will be slowly reverting some of the features that I attempted to add to enmap to make it support multiple connections, such as polling. Enmap 5.0 starts this process by removing the dependency on better-sqlite-pool. So, if you're using enmap in a sharded/multithreaded/multiprocess setup, don't update, and hold off on (JOSH)[https://www.npmjs.com/package/josh]. When JOSH is released, it'll be able to scale up with your application.

Documentation

Support

Support is offered on my official Evie.Codes Discord.

FAQs

Q: So what's Enmap

A: Enmaps are the Javascript Map() data structure with additional utility methods. This started as a pretty straight clone of the Discord.js Collections but since its creation has grown far beyond those methods alone.

Q: What is "Persistent"?

A: By using a database layer with better-sqlite3, any data added to the Enmap is stored not only in temporary memory but also backed up in a local database. This means that when you restart your project, your data is not lost and is loaded on startup.

Q: How big can the Enmap be?

A: The size of the memory used is directly proportional to the size of all the keys loaded in memory. The more data you have, the more complex it is, the more memory it can use. You can use the fetchAll options to reduce memory usage.

Q: Who did you make this for?

A: Myself because I do use it often. But also, I built it specifically for beginners in mind. Enmap's main goal is to remain simple to use, as fast as possible, and a solid as possible.

Q: What's is used for?

A: Enmap is useful for storing very simple key/value data for easy retrieval, and also for more complex objects with many properties. Mainly, because of who I originally made this for, it's used in Discord.js Bots to save currencies, content blocks, server settings, and user information for bans, blacklists, timers, warning systems, etc.

Testimonials

I have legit tried several databases, from popular complicated ones to pretty basic ones. The only database I had absolutely no issue with was and still is enmap.
I know how to use a real db, but enmap is so sweet and easy to use

install

npm i enmap

Downloadsweekly downloads

13,223

version

5.1.2

license

Apache-2.0

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability