# Sapphire Utilities Common NodeJS packages for Sapphire Repositories and others. Packages

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

Changelog

All notable changes to this project will be documented in this file.

@sapphire/utilities@3.18.2 - (2025-01-29)

🐛 Bug Fixes

• utilities: Ensure consistent typing for objectEntries, objectKeys and objectValues (598c24a) (#857 by @GeniusTimo)

@sapphire/utilities@3.18.0 - (2024-11-02)

🏠 Refactor

• Deprecate NonNullObject and AnyObject (0dce7d6) (#821 by @kyranet)
• cutText: Improve algorithm (db34661) (#820 by @kyranet)
• Rewrite roundNumber (1e7d2de) (#810 by @kyranet)

🐛 Bug Fixes

• Move browser imports (100ffb0) (#826 by @kyranet)

🚀 Features

• types: Add If and RequiredIf (143375f) (#825 by @kyranet)
• Add PrettifyObject type (5ac3f24) (#822 by @kyranet)
• utilities: Expose Arr to the docs (997614c) (#780 by @favna)

@sapphire/utilities@3.17.0 - (2024-07-23)

🏠 Refactor

• utilities: Rename baseVariants to toTitleCaseDiscordJsVariants (cd7e6b5) (#754 by @favna)

🐛 Bug Fixes

• deps: Update all non-major dependencies (083376a) (#763 by @renovate[bot])
• deps: Update all non-major dependencies (e7fdc5d) (#752 by @renovate[bot])

📝 Documentation

• utilities: Fix type in README (11863ec) (#776 by @kyranet)

🚀 Features

• Add DeepReadonly type (1e73db9) (#775 by @kyranet)

@sapphire/utilities@3.16.2 - (2024-05-21)

🐛 Bug Fixes

• utilities: Update re-exports on index level (902cee8)

@sapphire/utilities@3.16.1 - (2024-05-21)

🐛 Bug Fixes

• utilities: Fixed cjs bundle (f1db3f6)

@sapphire/utilities@3.16.0 - (2024-05-20)

📝 Documentation

• readme: Fix readme table of contents (c60e8bd)
• utilities: Fix tsdoc comments for debounce (e9f4de9)

🚀 Features

• utilities: Add capitalizeFirstLetter, hasAtLeastOneKeyInObject, and snakeToCamelCase (#747) (014e4e8)

@sapphire/utilities@3.15.3 - (2024-01-19)

🐛 Bug Fixes

• Fixed commonjs typings export mapping (#707) (216ff02)

@sapphire/utilities@3.15.2 - (2024-01-06)

🐛 Bug Fixes

• Fixed bun compatibility for @sapphire/utilities (#703) (ba07362)

@sapphire/utilities@3.15.1 - (2023-12-28)

📝 Documentation

• utilities: Fix tsdoc comments for omitKeysFromObject (afd7d27)

@sapphire/utilities@3.15.0 - (2023-12-28)

🚀 Features

• utilities: Add omitKeysFromObject utility function (#700) (eccf9f6)

🪞 Styling

• Run prettier on the codebase (1d6e994)

@sapphire/utilities@3.14.0 - (2023-12-04)

🐛 Bug Fixes

• utilities: Properly split CJS, ESM and IIFE (f9d8c8e)
• discord.js-utilities: Fixed isNsfwChannel typeguard by including ChannelType.GuildMedia (#665) (7c6cfe2)

📝 Documentation

• utilities: Improve typedoc (16c05ea)

🚀 Features

• tryParseJSON: Support replacer argument (#668) (4cf0978)

@sapphire/utilities@3.13.0 - (2023-07-21)

🏠 Refactor

• sleep: Align more closely with the Node.js API. This removes the AbortError class, if you were previously using it then check for instanceof DOMException and error.name === 'AbortError' (#626) (36cd38f)
• utilities: Make sleepSync its own file (#615) (5838b7e)

🐛 Bug Fixes

• deps: Update all non-major dependencies (#607) (9cc8bd0)

🚀 Features

• utilities: Add poll function (#616) (59d4c6b)

🧪 Testing

• sleepSync: Use spies for Date.now() (#617) (cf444df)
• pickRandom: Add test to cover empty arrays (b74394a)

@sapphire/utilities@3.12.0 - (2023-06-09)

🚀 Features

• utilities: Add retry function (#604) (37dee25)

🧪 Testing

• Update vitest to coverage v8 (a4bc6e4)

@sapphire/utilities@3.11.2 - (2023-05-06)

🐛 Bug Fixes

• utilities: Add support for TypedArray to deepClone (#592) (85dcd15)

@sapphire/utilities@3.11.1 - (2023-04-10)

🏃 Performance

• chunk: Remove clone (#574) (049047b)

🏠 Refactor

• utilities: Improve codeBlock and inlineCodeBlock (#498) (29b1e5a)

🐛 Bug Fixes

• deps: Update all non-major dependencies (#577) (291dd67)
• deps: Update all non-major dependencies (#545) (40ca040)
• deps: Update all non-major dependencies (#544) (cc78f17)
• deps: Update all non-major dependencies (#532) (8033d1f)
• deps: Update all non-major dependencies (#514) (21b07d5)
• deps: Update all non-major dependencies (#505) (6178296)

📝 Documentation

• Add @06000208 as a contributor (fa3349e)
• Add @didinele as a contributor (42ef7b6)
• Add @goestav as a contributor (0e56a92)
• Add @CitTheDev as a contributor (34169ea)
• Add @legendhimslef as a contributor (059b6f1)
• utilities: Add usage (#499) (0c4decc)

🧪 Testing

• Cleanup tests (aec1bb2)

@sapphire/utilities@3.11.0 - (2022-10-08)

🐛 Bug Fixes

• Override deprecated jsdoc (#488) (5cc9a2c)

🚀 Features

• Throttle function (#483) (541891a)
• utilities: Add pickRandom (#486) (20823c9)
• Added tryParseURL (#482) (46c5b49)

@sapphire/utilities@3.10.1 - (2022-10-02)

🐛 Bug Fixes

• utilities: Add missing deprecated exports (ef08c69)

📝 Documentation

• Add @r-priyam as a contributor (fb278ba)

@sapphire/utilities@3.10.0 - (2022-10-02)

🏠 Refactor

• Split @sapphire/time-utilities into 4 sub-packages (#462) (574299a)

🐛 Bug Fixes

• utilities: Fixed output file extensions (#480) (99a011d)
• utilities: Specify chunk file as side effect (7b34a81)
• deps: Update all non-major dependencies (#466) (dc08606)
• deps: Update all non-major dependencies (e20f299)

📝 Documentation

• Change name of @kyranet (#451) (df4fdef)

🚀 Features

• utilities: Add possibility to import single functions by appending them to the import path. (#454) (374c145)
• utilities: Add objectKeys function (#472) (384ff84)
• utilities: Add objectEntries function (#471) (84c1418)
• utilities: Add objectValues function (#474) (90c2409)
• utilities: Add sleep and sleepSync (#469) (8cd1293)

@sapphire/utilities@3.10.1 - (2022-10-02)

🐛 Bug Fixes

• utilities: Add missing deprecated exports (ef08c69)

📝 Documentation

• Add @r-priyam as a contributor (fb278ba)

@sapphire/utilities@3.10.0 - (2022-10-02)

🏠 Refactor

• Split @sapphire/time-utilities into 4 sub-packages (#462) (574299a)

🐛 Bug Fixes

• utilities: Fixed output file extensions (#480) (99a011d)
• utilities: Specify chunk file as side effect (7b34a81)
• deps: Update all non-major dependencies (#466) (dc08606)
• deps: Update all non-major dependencies (e20f299)

📝 Documentation

• Change name of @kyranet (#451) (df4fdef)

🚀 Features

• utilities: Add possibility to import single functions by appending them to the import path. (#454) (374c145)
• utilities: Add objectKeys function (#472) (384ff84)
• utilities: Add objectEntries function (#471) (84c1418)
• utilities: Add objectValues function (#474) (90c2409)
• utilities: Add sleep and sleepSync (#469) (8cd1293)

@sapphire/utilities@3.10.0 - (2022-10-02)

🏠 Refactor

• Split @sapphire/time-utilities into 4 sub-packages (#462) (574299a)

🐛 Bug Fixes

• utilities: Fixed output file extensions (#480) (99a011d)
• utilities: Specify chunk file as side effect (7b34a81)
• deps: Update all non-major dependencies (#466) (dc08606)
• deps: Update all non-major dependencies (e20f299)

📝 Documentation

• Change name of @kyranet (#451) (df4fdef)

🚀 Features

• utilities: Add possibility to import single functions by appending them to the import path. (#454) (374c145)
• utilities: Add objectKeys function (#472) (384ff84)
• utilities: Add objectEntries function (#471) (84c1418)
• utilities: Add objectValues function (#474) (90c2409)
• utilities: Add sleep and sleepSync (#469) (8cd1293)

@sapphire/utilities@3.9.3 - (2022-09-02)

🐛 Bug Fixes

• isNumber: Parse string parameter as number (allow string as parameter) (#444) (01e1b14)

📝 Documentation

• Update @RealShadowNova as a contributor (a869ba0)

@sapphire/utilities@3.9.1 - (2022-08-16)

🐛 Bug Fixes

• utilities: Fixed getDeepObjectKeys not returning proper values for arrays of not-objects (#428) (88f84e6)
• deps: Update all non-major dependencies (2308bd7)

📝 Documentation

• Fixed typos (#427) (e840a97)

@sapphire/utilities@3.9.1 - (2022-08-16)

🐛 Bug Fixes

• utilities: Fixed getDeepObjectKeys not returning proper values for arrays of not-objects (#428) (88f84e6)
• deps: Update all non-major dependencies (2308bd7)

📝 Documentation

• Fixed typos (#427) (e840a97)

@sapphire/utilities@3.9.0 - (2022-08-04)

🚀 Features

• utilities: Add getDeepObjectKeys (#413) (b8b0883)

@sapphire/utilities@3.8.0 - (2022-07-30)

🐛 Bug Fixes

• deps: Update all non-major dependencies (84af0db)

📝 Documentation

• Add @muchnameless as a contributor (a1221fe)
• Add @enxg as a contributor (d2382f0)
• Add @EvolutionX-10 as a contributor (efc3a32)

🚀 Features

• Add lazy (#406) (80db17c)

@sapphire/utilities@3.7.0 - (2022-07-01)

🏠 Refactor

• utilities: Make objectToTuples more type-safe (664580f)

🐛 Bug Fixes

• deps: Update all non-major dependencies (50cd8de)

📝 Documentation

• Add @MajesticString as a contributor (295b3e9)
• Add @Mzato0001 as a contributor (c790ef2)
• Add @NotKaskus as a contributor (00da8f1)
• Add @imranbarbhuiya as a contributor (fb674c2)
• Add @axisiscool as a contributor (ce1aa31)
• Add @dhruv-kaushikk as a contributor (ebbf43f)
• Add @Commandtechno as a contributor (f1d69fa)
• Fix typedoc causing OOM crashes (63ba41c)

🚀 Features

• utilities: Add AnyObject utility type (e442028)

🧪 Testing

• Migrate to vitest (#380) (075ec73)

3.6.2 (2022-04-01)

Note: Version bump only for package @sapphire/utilities

3.6.1 (2022-03-20)

Bug Fixes

• utilities: remove U type from cast (241ca66)

3.6.0 (2022-03-20)

Features

• utilities: add cast method (7e02bf5)

3.5.0 (2022-03-11)

Features

• utlities: add title case options param (#313) (ca7cffa)

3.4.0 (2022-03-06)

Features

• allow module: NodeNext (#306) (9dc6dd6)
• ts-config: add multi-config structure (#281) (b5191d7)

3.3.0 (2022-01-28)

Bug Fixes

• fixed date cloning (#275) (53d1f86)

Features

• change build system to tsup (#270) (365a53a)

3.2.1 (2022-01-21)

Bug Fixes

• fixed typos of communitys (e4e3a69), closes #263

3.2.0 (2022-01-10)

Bug Fixes

• utilities: make NonNullObject require object (#242) (5e0f161)

Features

• utilities: support custom constructors for isObject (#241) (701c2c2)

3.1.0 (2021-11-19)

Features

• add array partitioning (#220) (42d6b81)

3.0.8 (2021-11-15)

Bug Fixes

• utilities: target ES2019 for create-react-app support (95575ed)

3.0.7 (2021-11-06)

Note: Version bump only for package @sapphire/utilities

3.0.6 (2021-10-28)

Bug Fixes

• deepClone: fixed deep cloning when there are classes (d3aeed1)

3.0.5 (2021-10-26)

Note: Version bump only for package @sapphire/utilities

3.0.4 (2021-10-17)

Bug Fixes

• allow more node & npm versions in engines field (5977d2a)

3.0.3 (2021-10-11)

Note: Version bump only for package @sapphire/utilities

3.0.2 (2021-10-08)

Bug Fixes

• utilities: correct forgotten abstract (#195) (20b7ef7)

3.0.1 (2021-10-04)

Bug Fixes

• utilities: add AbstractCtor and AbstractConstructor and remove abstract from their counterparts (dbc0321)
• utilities: support abstract classes for Ctor utility type (1ce3136)

3.0.0 (2021-10-04)

Bug Fixes

• utilities: rename Awaited<T> to Awaitable<T> (#193) (6ff3e28)

Features

• utilities: add empty array to 'isNullishOrEmpty' (#168) (8f9e615)
• utilities: set minimum NodeJS to v14 (79aa230)
• utilities: support abstract classes for Constructor utility type (#194) (732d5a0)

BREAKING CHANGES

• utilities: Awaited has been renamed to Awaitable

2.0.1 (2021-07-20)

Bug Fixes

• utilities: add tsdoc for filter functions (36d51d1)

2.0.0 (2021-07-17)

Code Refactoring

• rateLimits: rewrite all of it (#130) (320778c)

BREAKING CHANGES

• rateLimits: Removed Bucket

1.7.0 (2021-07-11)

Features

• utilities: add 3 new helper methods (4ebcd43)

1.6.1 (2021-06-27)

Note: Version bump only for package @sapphire/utilities

1.6.0 (2021-06-19)

Features

• utilities: update utilities with more stuff (#122) (5dfb668)

1.5.3 (2021-06-06)

Bug Fixes

• remove peer deps, update dev deps, update READMEs (#124) (67256ed)

1.5.2 (2021-05-20)

Bug Fixes

• utilities: mark package as side effect free (73cbabd)

1.5.1 (2021-05-02)

Bug Fixes

• drop the www. from the SapphireJS URL (494d89f)
• update all the SapphireJS URLs from .com to .dev (f59b46d)

1.5.0 (2021-04-21)

Bug Fixes

• utilities: resolve lgtm error (eb5f4e6)

Features

• add @sapphire/embed-jsx (#100) (7277a23)

1.4.8 (2021-04-19)

Bug Fixes

• change all Sapphire URLs from "project"->"community" & use our domain where applicable 👨‍🌾🚜 (#102) (835b408)

1.4.7 (2021-04-03)

Note: Version bump only for package @sapphire/utilities

1.4.6 (2021-03-16)

Bug Fixes

• remove terser from all packages (#79) (1cfe4e7)

1.4.5 (2021-02-16)

Note: Version bump only for package @sapphire/utilities

1.4.4 (2021-01-25)

Note: Version bump only for package @sapphire/utilities

1.4.3 (2021-01-16)

Note: Version bump only for package @sapphire/utilities

1.4.2 (2021-01-14)

Bug Fixes

• utilities: fix parseUrl not working in v1.4.1 (c1fe990)

1.4.1 (2021-01-14)

Bug Fixes

• utilities: fixed return type for parseURL (718065a)
• utilities: properly type parseUrl (dcf800f)

1.4.0 (2021-01-13)

Features

• utilities: add Nullish utility type (a7e32bd)

1.3.1 (2021-01-01)

Note: Version bump only for package @sapphire/utilities

1.3.0 (2020-12-26)

Features

• decorators: add createFunctionPrecondition, fixed build (#51) (c87d5db)

1.2.0 (2020-12-22)

Features

• utilities: add debounce (#45) (4762ebf)

1.1.1 (2020-11-15)

Bug Fixes

• utilities: add alias of isNullish to isNullOrUndefined (eadf28f), closes #30
• utilities: pass keep_classnames to terser (9425c82)
• utilities: pass keep_fnames to terser (4b8fde2)

1.1.0 (2020-11-07)

Features

• utilities: add range function (f9ac35e)
• utilities: add range function (a59d623)
• added time-utilities package (#26) (f17a333)

1.0.3 (2020-11-04)

Bug Fixes

• utilities: properly specify ESM and CommonJS exports (11f4f9b)

1.0.2 (2020-10-11)

Bug Fixes

• ratelimits,snowflake,utilities: fixed esm output target (9fdab3f)
• utilities: fixed up mergeDefault (#21) (76561db)

1.0.1 (2020-09-20)

Note: Version bump only for package @sapphire/utilities

1.0.0 (2020-09-05)

Bug Fixes

• utilities: fix types for isFunction (991de0d)
• utilities: fixed types for codeBlock (abae927)
• utilities: fixed types for isThenable (0563b8d)
• utilities: put lang as first param (54bfba7)

Features

• implement snowflake (5ba4e2d)
• decorators: add decorators package (#4) (677b3e5)
• utilities: add all utilities (94fcae8)