Table of Contents
🧮 Features
- Written in TypeScript
- Bundled with esbuild so it can be used in NodeJS and browsers
- Offers CommonJS, ESM bundles
- Fully tested
🚀 Installation
Note In the following example commands we use
npm installto fit best suited to the basic environment, feel free to replacenpm installwith your package manager of choice (yarn, pnpm or whatever).
npm install @dareharu/utilities🌟 Usage
You can import individual utility function from subpath like: @dareharu/utilities/keyMirror or the entire library.
import { keyMirror } from '@dareharu/utilities/keyMirror';
// or
import { keyMirror } from '@dareharu/utilities';Note For TypeScript users, subpath import are only supported in
--moduleResolution node16and--moduleResolution nodenext. More information can be found in the issue #50794 on the microsoft/TypeScript repository.
Note While this section uses
require, the imports match 1:1 with ESM imports. For exampleconst { deepClone } = require('@dareharu/utilities')equalsimport { deepClone } from '@dareharu/utilities'.
createBitField
Converts the given array to a bitfield object.
const Group = createBitField(['Administrator', 'Moderator', 'Member', 'User', 'Guest']);
assert.equal(Group.Administrator, 1);
assert.equal(Group.Moderator, 2);
assert.equal(Group.Member, 4);
assert.equal(Group.User, 8);
assert.equal(Group.Guest, 16);See also this package: @sapphire/bitfield
keyMirror
Creates a new object that assigned each value of the given array into property key and value.
const ChatInputId = keyMirror(['Ticket', 'Message']);
assert.equal(ChatInputId.Ticket, 'Ticket');
assert.equal(ChatInputId.Message, 'Message');const ResponseType = {
...keyMirror(['Create', 'Delete'], { prefix: 'Ticket' }),
...keyMirror(['Send', 'Receive'], { prefix: 'Message' })
};
assert.equal(ResponseType.TicketCreate, 'TicketCreate');
assert.equal(ResponseType.TicketDelete, 'TicketDelete');
assert.equal(ResponseType.MessageSend, 'MessageSend');
assert.equal(ResponseType.MessageReceive, 'MessageReceive');const ResponseType = {
...keyMirror(['Channel', 'Message'], { prefix: 'Haru', suffix: 'Create' }),
...keyMirror(['Channel', 'Message'], { prefix: 'Haru', suffix: 'Delete' }),
...keyMirror(['Channel', 'Message'], { prefix: 'Haru', suffix: 'Update' })
};
assert.equal(ResponseType.HaruChannelCreate, 'HaruChannelCreate');
assert.equal(ResponseType.HaruChannelDelete, 'HaruChannelDelete');
assert.equal(ResponseType.HaruChannelUpdate, 'HaruChannelUpdate');
assert.equal(ResponseType.HaruMessageCreate, 'HaruMessageCreate');
assert.equal(ResponseType.HaruMessageDelete, 'HaruMessageDelete');
assert.equal(ResponseType.HaruMessageUpdate, 'HaruMessageUpdate');🔗 Meta
Contributing
- Fork it!
- Create your feature branch:
git switch -c my-new-feature - Commit your changes:
git commit -am 'Add awesome feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request!
License
Released under the MIT License.