atomic-fns 1.1.4 → 1.1.5

package/README.md

@@ -6,18 +6,18 @@
 
 Stop shipping code built for browsers from 2015.
 
-You may prefer this because it's:
+You may prefer this library because:
 
 * **TypeScript & docs**: Includes type declaration files and js with JSDocs for best in class experience.
 * **Zero deps**: Built from scratch with no runtime dependencies or polyfills.
 * **ESNext**: Uses modern idiomatic syntax, data structures, and control flow techniques.
 * **Modular**: Pick what you need. Supports tree-shaking, no side effects, and works with all bundlers.
 * **Lazy**: Leverage generators, iterators, and functional composition.
-* **Tests**: All modules have comprehensive test suites and public apis are 100% covered.
+* **Tests**: All modules have comprehensive test suites and 100% test coverage.
 
 ## Docs
 
-📖 Available at [https://atomic-stack.github.io/atomic-fns/](atomic-stack.github.io/atomic-fns)
+📖 Available at [atomic-fns](atomic-stack.github.io/atomic-fns)
 
 ## Get Started
 
@@ -69,6 +69,15 @@ When working with objects, functions in this library use these custom operators
 
 [`Decimal`](https://atomic-stack.github.io/atomic-fns/classes/decimal.Decimal.html) provides support for correct rounded floating point arithmetic, with arbitrary precision.
 
+This fixes precision issues with float arithmetic, for example:
+```
+0.1 + 0.1 + 0.1
+// 0.30000000000000004
+
+decimal('0.1').add('0.1').add('0.1').toNumber()
+// 0.3
+```
+
 Some common base interfaces and typing patterns you may have seen like `Optional`, `Result`, `Comparable`, `Iterator`, and others.
 
 ### Sorted Containers

package/dist/index.d.ts

@@ -7,3 +7,4 @@ export * from './itertools/index.js';
 export * from './math/index.js';
 export * from './operators/index.js';
 export * from './random/index.js';
+export * from './string/index.js';

package/dist/index.js

@@ -7,3 +7,4 @@ export * from './itertools/index.js';
 export * from './math/index.js';
 export * from './operators/index.js';
 export * from './random/index.js';
+export * from './string/index.js';

package/dist/string/index.d.ts

@@ -0,0 +1,190 @@
+/**
+ * This module includes utilities for working with strings.
+ *
+ * @module string
+ */
+/**
+ * Converts only the first character of the given string to upper case. Note that the rest of the characters are preserved.
+ * @param {string} s The string
+ * @returns {string} Returns the sentence string.
+ * @example
+```js
+sentenceCase('a test')
+// 'A test'
+
+sentenceCase('TEST')
+// 'TEST'
+```
+ * @see {@link capitalize}
+ */
+export declare function sentenceCase(s: string): string;
+/**
+ * Converts the first character of the given string to upper case and the rest to lower case.
+ * @param {string} s The string to capitalize
+ * @returns {string} Returns the capitalized string.
+ * @example
+```js
+capitalize('TEST')
+// 'Test'
+```
+ * @see {@link titleCase}
+ */
+export declare function capitalize(s: string): string;
+/**
+ * Split a string into an array of its words.
+ * @param {string} s The string to split
+ * @param {RegExp | string} [pattern] The pattern to match words
+ * @returns {string[]} Returns the words array.
+ * @example
+```js
+words('lord of the rings')
+// ['lord', 'of', 'the', 'rings']
+```
+ */
+export declare function words(s: string, pattern?: RegExp | string): string[];
+/**
+ * Create a new string which is the concatenation of the words in the given input.
+ * @param {string} s The string to join
+ * @param {string} [sep=' '] The separator to use
+ * @returns {string} Returns the joined string.
+ * @example
+```js
+join('Lord Of The Rings', '-')
+// 'Lord-Of-The-Rings'
+```
+ */
+export declare function join(s: string, sep?: string): string;
+/**
+ * Checks if a string contains only alphanumeric characters.
+ * @param {string} s The string
+ * @returns {boolean} Returns `true` if the string contains only alphanumeric.
+ * @example
+```js
+isAlnum('alpha1234')
+// true
+
+isAlnum('oops!')
+// false
+```
+ */
+export declare function isAlnum(s: string): boolean;
+/**
+ * Checks if a string contains only alphabetic characters.
+ * @param {string} s The string
+ * @returns {boolean} Returns `true` if the string contains only alphabetic.
+ * @example
+```js
+isAlpha('alpha1234')
+// false
+
+isAlpha('letters')
+// true
+```
+ */
+export declare function isAlpha(s: string): boolean;
+/**
+ * Checks if a string contains only numeric characters.
+ * @param {string} s The string
+ * @returns {boolean} Returns `true` if the string contains only numeric.
+ * @example
+```js
+isNumeric('alpha1234')
+// false
+
+isNumeric('1234')
+// true
+```
+ */
+export declare function isNumeric(s: string): boolean;
+/**
+ * Returns a new string with only valid ASCII characters
+ * @param {string} s The string
+ * @returns {string} The ASCII characters in the given string
+ * @example
+```js
+asciify('äÄçÇéÉêPHP-MySQLöÖÐþúÚ')
+// 'PHP-MySQL'
+```
+ */
+export declare function asciify(s: string): string;
+/**
+ * Replaces any accent characters in the string with non accents.
+ * @param {string} s The string
+ * @returns {string} The new string without accents
+ * @example
+```js
+removeAccents('Antoine de Saint-Exupéry')
+// 'Antoine de Saint-Exupery'
+```
+ */
+export declare function removeAccents(s: string): string;
+/**
+ * Capitalizes the first letter of every word in the string.
+ * @param {string} s The string to capitalize
+ * @returns {string} Returns the title cased string.
+ * @example
+```js
+titleCase('lord of the rings')
+// 'Lord Of The Rings'
+```
+@see {@link capitalize}
+ */
+export declare function titleCase(s: string): string;
+/**
+ * Converts the string to camel case.
+ * @param {string} s The string to convert
+ * @returns {string} Returns the camel cased string.
+ * @example
+```js
+camelCase('Equipment class name')
+// 'equipmentClassName'
+```
+ */
+export declare function camelCase(s: string): string;
+/**
+ * Converts the string to Pascal case.
+ * @param {string} s The string to convert
+ * @returns {string} Returns the Pascal cased string.
+ * @example
+```js
+pascalCase('equipment class name')
+// 'EquipmentClassName'
+```
+ */
+export declare function pascalCase(s: string): string;
+/**
+ * Converts the string to snake case.
+ * @param {string} s The string to convert
+ * @returns {string} Returns the snake cased string.
+ * @example
+```js
+snakeCase('Equipment Class Name')
+// 'equipment_class_name'
+```
+ */
+export declare function snakeCase(s: string): string;
+/**
+ * Converts a string to kebab case.
+ * @param {string} s The string
+ * @returns {string} Returns the kebab cased string.
+ * @example
+```js
+kebabCase('Equipment Class Name')
+// 'equipment-class-name'
+
+kebabCase('equipment_class_name')
+// 'equipment-class-name'
+```
+ */
+export declare function kebabCase(s: string): string;
+/**
+ * Returns a url-safe slug for the given string. Note that by default it will preserve any capitalization in the given string.
+ * @param {string} s The string
+ * @returns {string} A url-safe slug version of the string
+ * @example
+```js
+slugify('Antoine de Saint-Exupéry')
+// 'Antoine-de-Saint-Exupery'
+```
+ */
+export declare function slugify(s: string): string;

package/dist/string/index.js

@@ -0,0 +1,229 @@
+/**
+ * This module includes utilities for working with strings.
+ *
+ * @module string
+ */
+const WORDS_REGEX = // eslint-disable-next-line no-control-regex
+ /[A-Z\xc0-\xd6\xd8-\xde]?[a-z\xdf-\xf6\xf8-\xff]+(?:['’](?:d|ll|m|re|s|t|ve))?(?=[\xac\xb1\xd7\xf7\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xbf\u2000-\u206f \t\x0b\f\xa0\ufeff\n\r\u2028\u2029\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u202f\u205f\u3000]|[A-Z\xc0-\xd6\xd8-\xde]|$)|(?:[A-Z\xc0-\xd6\xd8-\xde]|[^\ud800-\udfff\xac\xb1\xd7\xf7\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xbf\u2000-\u206f \t\x0b\f\xa0\ufeff\n\r\u2028\u2029\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u202f\u205f\u3000\d+\u2700-\u27bfa-z\xdf-\xf6\xf8-\xffA-Z\xc0-\xd6\xd8-\xde])+(?:['’](?:D|LL|M|RE|S|T|VE))?(?=[\xac\xb1\xd7\xf7\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xbf\u2000-\u206f \t\x0b\f\xa0\ufeff\n\r\u2028\u2029\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u202f\u205f\u3000]|[A-Z\xc0-\xd6\xd8-\xde](?:[a-z\xdf-\xf6\xf8-\xff]|[^\ud800-\udfff\xac\xb1\xd7\xf7\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xbf\u2000-\u206f \t\x0b\f\xa0\ufeff\n\r\u2028\u2029\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u202f\u205f\u3000\d+\u2700-\u27bfa-z\xdf-\xf6\xf8-\xffA-Z\xc0-\xd6\xd8-\xde])|$)|[A-Z\xc0-\xd6\xd8-\xde]?(?:[a-z\xdf-\xf6\xf8-\xff]|[^\ud800-\udfff\xac\xb1\xd7\xf7\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xbf\u2000-\u206f \t\x0b\f\xa0\ufeff\n\r\u2028\u2029\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u202f\u205f\u3000\d+\u2700-\u27bfa-z\xdf-\xf6\xf8-\xffA-Z\xc0-\xd6\xd8-\xde])+(?:['’](?:d|ll|m|re|s|t|ve))?|[A-Z\xc0-\xd6\xd8-\xde]+(?:['’](?:D|LL|M|RE|S|T|VE))?|\d*(?:1ST|2ND|3RD|(?![123])\dTH)(?=\b|[a-z_])|\d*(?:1st|2nd|3rd|(?![123])\dth)(?=\b|[A-Z_])|\d+|(?:[\u2700-\u27bf]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe2f\u20d0-\u20ff]|\ud83c[\udffb-\udfff])?(?:\u200d(?:[^\ud800-\udfff]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe2f\u20d0-\u20ff]|\ud83c[\udffb-\udfff])?)*/g;
+/**
+ * Converts only the first character of the given string to upper case. Note that the rest of the characters are preserved.
+ * @param {string} s The string
+ * @returns {string} Returns the sentence string.
+ * @example
+```js
+sentenceCase('a test')
+// 'A test'
+
+sentenceCase('TEST')
+// 'TEST'
+```
+ * @see {@link capitalize}
+ */
+export function sentenceCase(s) {
+    return `${(s[0] || '').toLocaleUpperCase()}${s.substring(1) || ''}`;
+}
+/**
+ * Converts the first character of the given string to upper case and the rest to lower case.
+ * @param {string} s The string to capitalize
+ * @returns {string} Returns the capitalized string.
+ * @example
+```js
+capitalize('TEST')
+// 'Test'
+```
+ * @see {@link titleCase}
+ */
+export function capitalize(s) {
+    return `${(s[0] || '').toLocaleUpperCase()}${(s.substring(1) || '').toLocaleLowerCase()}`;
+}
+/**
+ * Split a string into an array of its words.
+ * @param {string} s The string to split
+ * @param {RegExp | string} [pattern] The pattern to match words
+ * @returns {string[]} Returns the words array.
+ * @example
+```js
+words('lord of the rings')
+// ['lord', 'of', 'the', 'rings']
+```
+ */
+export function words(s, pattern) {
+    if (pattern != null)
+        return s.split(pattern);
+    return s.match(WORDS_REGEX) || [];
+}
+/**
+ * Create a new string which is the concatenation of the words in the given input.
+ * @param {string} s The string to join
+ * @param {string} [sep=' '] The separator to use
+ * @returns {string} Returns the joined string.
+ * @example
+```js
+join('Lord Of The Rings', '-')
+// 'Lord-Of-The-Rings'
+```
+ */
+export function join(s, sep = ' ') {
+    return words(s).join(sep);
+}
+/**
+ * Checks if a string contains only alphanumeric characters.
+ * @param {string} s The string
+ * @returns {boolean} Returns `true` if the string contains only alphanumeric.
+ * @example
+```js
+isAlnum('alpha1234')
+// true
+
+isAlnum('oops!')
+// false
+```
+ */
+export function isAlnum(s) {
+    return /^[\p{L}\p{N}]+$/gu.test(s);
+}
+/**
+ * Checks if a string contains only alphabetic characters.
+ * @param {string} s The string
+ * @returns {boolean} Returns `true` if the string contains only alphabetic.
+ * @example
+```js
+isAlpha('alpha1234')
+// false
+
+isAlpha('letters')
+// true
+```
+ */
+export function isAlpha(s) {
+    return /^[\p{L}]+$/gu.test(s);
+}
+/**
+ * Checks if a string contains only numeric characters.
+ * @param {string} s The string
+ * @returns {boolean} Returns `true` if the string contains only numeric.
+ * @example
+```js
+isNumeric('alpha1234')
+// false
+
+isNumeric('1234')
+// true
+```
+ */
+export function isNumeric(s) {
+    return /^[\p{N}]+$/gu.test(s);
+}
+/**
+ * Returns a new string with only valid ASCII characters
+ * @param {string} s The string
+ * @returns {string} The ASCII characters in the given string
+ * @example
+```js
+asciify('äÄçÇéÉêPHP-MySQLöÖÐþúÚ')
+// 'PHP-MySQL'
+```
+ */
+export function asciify(s) {
+    // eslint-disable-next-line no-control-regex
+    return s.replace(/[^\x00-\x7F]/g, '');
+}
+/**
+ * Replaces any accent characters in the string with non accents.
+ * @param {string} s The string
+ * @returns {string} The new string without accents
+ * @example
+```js
+removeAccents('Antoine de Saint-Exupéry')
+// 'Antoine de Saint-Exupery'
+```
+ */
+export function removeAccents(s) {
+    return s.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
+}
+/**
+ * Capitalizes the first letter of every word in the string.
+ * @param {string} s The string to capitalize
+ * @returns {string} Returns the title cased string.
+ * @example
+```js
+titleCase('lord of the rings')
+// 'Lord Of The Rings'
+```
+@see {@link capitalize}
+ */
+export function titleCase(s) {
+    return words(s)
+        .map((word) => capitalize(word))
+        .join(' ');
+}
+/**
+ * Converts the string to camel case.
+ * @param {string} s The string to convert
+ * @returns {string} Returns the camel cased string.
+ * @example
+```js
+camelCase('Equipment class name')
+// 'equipmentClassName'
+```
+ */
+export function camelCase(s) {
+    return words(s).reduce((acc, next) => `${acc}${!acc ? next.toLowerCase() : next[0].toUpperCase() + next.slice(1).toLowerCase()}`, '');
+}
+/**
+ * Converts the string to Pascal case.
+ * @param {string} s The string to convert
+ * @returns {string} Returns the Pascal cased string.
+ * @example
+```js
+pascalCase('equipment class name')
+// 'EquipmentClassName'
+```
+ */
+export function pascalCase(s) {
+    return sentenceCase(camelCase(s));
+}
+/**
+ * Converts the string to snake case.
+ * @param {string} s The string to convert
+ * @returns {string} Returns the snake cased string.
+ * @example
+```js
+snakeCase('Equipment Class Name')
+// 'equipment_class_name'
+```
+ */
+export function snakeCase(s) {
+    return join(s, '_').toLowerCase();
+}
+/**
+ * Converts a string to kebab case.
+ * @param {string} s The string
+ * @returns {string} Returns the kebab cased string.
+ * @example
+```js
+kebabCase('Equipment Class Name')
+// 'equipment-class-name'
+
+kebabCase('equipment_class_name')
+// 'equipment-class-name'
+```
+ */
+export function kebabCase(s) {
+    return join(s, '-').toLowerCase();
+}
+/**
+ * Returns a url-safe slug for the given string. Note that by default it will preserve any capitalization in the given string.
+ * @param {string} s The string
+ * @returns {string} A url-safe slug version of the string
+ * @example
+```js
+slugify('Antoine de Saint-Exupéry')
+// 'Antoine-de-Saint-Exupery'
+```
+ */
+export function slugify(s) {
+    const slug = join(removeAccents(s), '-');
+    const urlSafe = slug.replace(/[^a-zA-Z0-9-_]/g, '');
+    return urlSafe;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "atomic-fns",
   "description": "Like Lodash, but for ESNext and with types. Stop shipping code built for browsers from 2015.",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "files": [
     "dist/*"
   ],