Skip to content

eslachance/enmap

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Enmap - Enhanced Maps

Discord server NPM version NPM downloads Patreon

Enmap Logo

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.

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 may use. You can use the fetchAll option to reduce memory usage.

Q: Who did you make this for?

A: Enmap was made specifically for beginners in mind. It's for you, the budding javascript developer that wants to save data in a database but doesn't want to learn SQL - yet. It's also for people that want to rapidly prototype some app that depends on a database but doesn't want to have to deal with queries, even if it's not the most efficient way to do things.

Q: What can it be 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

Some user comments!

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

Thanks to Enmap, I am able to do tons of things that I never thought I would accomplish. From custom settings to even just saving the little things, it is amazing to use.

Enmap helped me, and it stills helps me, because it is very simple and useful. Thank you for creating Enmap.

Without your tutorials I didn't have an internship and some work.. :))

Enmap was introduced to me fairly early, and has been essential to the growth and development of my bot. Without it, I'd have to use and learn complicated and unsafe systems. Enmap has helped me do exactly what I want with my bot. Thank you.

About

Enhanced Map structure with additional utility methods.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published