@discordjs/collection

What is @discordjs/collection?

@discordjs/collection is a powerful utility for managing collections of data. It extends JavaScript's native Map class and provides additional methods that are useful for handling and manipulating collections, especially in the context of Discord bots.

What are @discordjs/collection's main functionalities?

Basic Collection Operations

This feature allows you to perform basic operations such as setting, getting, and checking the existence of elements in the collection.

const { Collection } = require('@discordjs/collection');
const collection = new Collection();
collection.set('key1', 'value1');
collection.set('key2', 'value2');
console.log(collection.get('key1')); // Output: value1
console.log(collection.has('key2')); // Output: true
console.log(collection.size); // Output: 2

Filtering and Mapping

This feature allows you to filter and map the elements in the collection, providing a way to transform and query the data.

const { Collection } = require('@discordjs/collection');
const collection = new Collection();
collection.set('key1', 10);
collection.set('key2', 20);
collection.set('key3', 30);
const filtered = collection.filter(value => value > 15);
console.log(filtered); // Output: Collection { 'key2' => 20, 'key3' => 30 }
const mapped = collection.map(value => value * 2);
console.log(mapped); // Output: [ 20, 40, 60 ]

Reducing and Finding

This feature allows you to reduce the collection to a single value and find specific elements based on a condition.

const { Collection } = require('@discordjs/collection');
const collection = new Collection();
collection.set('key1', 1);
collection.set('key2', 2);
collection.set('key3', 3);
const sum = collection.reduce((acc, value) => acc + value, 0);
console.log(sum); // Output: 6
const found = collection.find(value => value === 2);
console.log(found); // Output: 2

Other packages similar to @discordjs/collection

lodash

Lodash is a popular utility library that provides a wide range of functions for manipulating arrays, objects, and other data structures. It offers similar functionalities to @discordjs/collection, such as filtering, mapping, and reducing collections, but it is more general-purpose and not specifically tailored for Discord bots.

immutable

Immutable.js provides immutable data structures, which can be useful for managing collections of data in a way that prevents accidental mutations. While it offers similar functionalities like filtering and mapping, it focuses on immutability, which is a different approach compared to @discordjs/collection's mutable collections.

collect.js

Collect.js is a library that provides a fluent and convenient way to work with arrays and objects in JavaScript. It offers chainable methods for manipulating collections, similar to @discordjs/collection, but it is designed to be more general-purpose and not specifically for Discord bots.

README

About

@discordjs/collection is a powerful utility data structure used in discord.js.

Installation

Node.js 18 or newer is required.

npm install @discordjs/collection
yarn add @discordjs/collection
pnpm add @discordjs/collection

Links

• Website (source)
• Documentation
• Guide (source) Also see the v13 to v14 Update Guide, which includes updated and removed items from the library.
• discord.js Discord server
• Discord API Discord server
• GitHub
• npm
• Related libraries

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation.
See the contribution guide if you'd like to submit a PR.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official discord.js Server.