atomic-fns 0.3.3 → 0.3.5

package/core/functools/index.ts

@@ -98,7 +98,10 @@ export const compose = (...args) => flow(args.reverse())
  * @param {Function} [resolver] The function to resolve the cache key.
  * @return {Function} Returns the new memoized function.
  */
-export function memoize(func: Function, resolver?: Function): Function {
+export function memoize<T>(
+  func: Function<T>,
+  resolver?: Function
+): Function<ReturnType<typeof func>> {
   const cache = new Map()
   return (...args) => {
     const key = resolver ? resolver(...args) : args[0]
@@ -188,14 +191,14 @@ single(3) // => 1
 // => `func` is invoked only once.
 ```
  */
-export function once(func: Function) {
+export function once<T>(func: Function<T>) {
   let result, isCalled
   return (...args) => {
     if (!isCalled) {
       result = func(...args)
       isCalled = true
     }
-    return result
+    return result as T
   }
 }
 
@@ -203,6 +206,8 @@ export type Maybe<T> = T | undefined
 
 export type Result<T, E = any> = [Maybe<T>, Maybe<E>]
 
+export type Optional<T> = Maybe<T>
+
 /**
  * Wraps a function to catch any exceptions inside and return a `go` style error-return type {@link Result}.
  *

package/core/globals/index.d.ts

@@ -4,7 +4,7 @@
  * @module Globals
  */
 /** This is just a noop function. */
-export declare const _: () => void;
+export declare const noop: () => void;
 /**
  * A generic function type with arbitrary arguments and return.
  */
@@ -92,10 +92,15 @@ export declare function type(value: any): any;
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString | Object.toString }
  */
 export declare const str: (obj: any) => any;
+export declare function hasOwnProperty(obj: any, prop: any): boolean;
 /** Check if value is a boolean type. */
 export declare const isBool: (x: any) => x is boolean;
+/** Check if value is an `Error` type. */
+export declare const isError: (x: any) => x is Error;
 /** Check if value is an iterable type. */
 export declare const isIterable: (x: any) => x is IterableIterator<any>;
+/** Check if value is a native `Date` type. */
+export declare const isDate: (x: any) => x is Date;
 /** Check if value is an object type. */
 export declare const isObject: (x: any) => x is Object;
 /** Check if value is a string type. */
@@ -107,28 +112,42 @@ export declare const isArray: (x: any) => x is any[];
  * A value is considered array-like if it's not a function and has a `.length` number property.
  */
 export declare const isArrayLike: (x: any) => boolean;
-/** Check if value is a function type. */
-export declare const isFunc: (x: any) => x is Function<any>;
 /** Check if value is a number type. */
 export declare const isNumber: (x: any) => x is number;
+/** Check if value is an integer number type. */
+export declare const isInteger: (x: any) => x is number;
 /** Check if value is a bigint type. */
 export declare const isBigint: (x: any) => x is BigInt;
 /** Check if value is NaN based on `Number.isNaN`. */
 export declare const isNaN: (x: any) => x is number;
 /** Check if value is a Promise type. */
 export declare const isPromise: (x: any) => x is Promise<any>;
+/** Check if value is a function type. */
+export declare const isFunction: (x: any) => x is Function<any>;
 /** Check if value is an async function type. */
-export declare const isAsync: (x: any) => boolean;
+export declare const isAsyncFunction: (x: any) => boolean;
 /** Check if value is a generator function type. */
 export declare const isGenerator: (x: any) => x is Generator<unknown, any, unknown>;
 /** Check if value is `null` or `undefined`. */
 export declare const isNull: (x: any) => x is null | undefined;
+/** Check if value === `undefined`. */
+export declare function isUndefined(o: any): boolean;
 /** Check if value is not `null` or `undefined`. */
 export declare const notNull: (x: any) => boolean;
 /** Returns `true` for objects without length or falsy values. */
 export declare const isEmpty: (x: any) => boolean;
+/** Check if value is a `RegExp` type */
+export declare const isRegExp: (x: any) => x is RegExp;
 /** Check if value is a `Symbol` type */
 export declare const isSymbol: (x: any) => x is symbol;
+/** Check if value is a `Set` type. */
+export declare const isSet: <T>(x: any) => x is Set<T>;
+/** Check if value is a `Map` type. */
+export declare const isMap: <K, V>(x: any) => x is Map<K, V>;
+/** Check if value is a `WeakSet` type. */
+export declare const isWeakSet: <T extends object>(x: any) => x is WeakSet<T>;
+/** Check if value is a `WeakMap` type. */
+export declare const isWeakMap: <K extends object, V>(x: any) => x is WeakMap<K, V>;
 /**
  * Returns the number of elements in a collection type.
  *

package/core/globals/index.js

@@ -4,7 +4,7 @@
  * @module Globals
  */
 /** This is just a noop function. */
-export const _ = () => { };
+export const noop = () => { };
 /** A function that always returns `true`. */
 export const True = () => true;
 /** A function that always returns `false`. */
@@ -122,14 +122,21 @@ export function type(value) {
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString | Object.toString }
  */
 export const str = (obj) => (obj != null ? obj.toString() : '');
+export function hasOwnProperty(obj, prop) {
+    return Object.prototype.hasOwnProperty.call(obj, prop);
+}
 /** Check if value is a boolean type. */
 export const isBool = (x) => type(x) === 'boolean';
+/** Check if value is an `Error` type. */
+export const isError = (x) => x instanceof Error;
 /** Check if value is an iterable type. */
 export const isIterable = (x) => {
     if (x == null)
         return false;
     return typeof x[Symbol.iterator] === 'function';
 };
+/** Check if value is a native `Date` type. */
+export const isDate = (x) => x instanceof Date;
 /** Check if value is an object type. */
 export const isObject = (x) => typeof x === 'object' && type(x) === 'object';
 /** Check if value is a string type. */
@@ -144,30 +151,46 @@ export const isArrayLike = (x) => {
     const T = type(x);
     return T === 'array' || (T === 'object' && isNumber(x.length));
 };
-/** Check if value is a function type. */
-export const isFunc = (x) => x?.constructor === Function;
 /** Check if value is a number type. */
 export const isNumber = (x) => type(x) === 'number';
+/** Check if value is an integer number type. */
+export const isInteger = (x) => type(x) === 'number' && Math.floor(x) === x;
 /** Check if value is a bigint type. */
 export const isBigint = (x) => type(x) === 'bigint';
 /** Check if value is NaN based on `Number.isNaN`. */
 export const isNaN = (x) => Number.isNaN(x);
 /** Check if value is a Promise type. */
 export const isPromise = (x) => type(x) === 'Promise';
+/** Check if value is a function type. */
+export const isFunction = (x) => x?.constructor === Function;
 /** Check if value is an async function type. */
-export const isAsync = (x) => x?.constructor.name === 'AsyncFunction';
+export const isAsyncFunction = (x) => x?.constructor.name === 'AsyncFunction';
 /** Check if value is a generator function type. */
 export const isGenerator = (x) => {
     return x?.constructor.constructor?.name === 'GeneratorFunction';
 };
 /** Check if value is `null` or `undefined`. */
 export const isNull = (x) => x == null;
+/** Check if value === `undefined`. */
+export function isUndefined(o) {
+    return typeof o === 'undefined';
+}
 /** Check if value is not `null` or `undefined`. */
 export const notNull = (x) => x != null;
 /** Returns `true` for objects without length or falsy values. */
 export const isEmpty = (x) => (len(x) === 0 ? true : !x);
+/** Check if value is a `RegExp` type */
+export const isRegExp = (x) => x instanceof RegExp;
 /** Check if value is a `Symbol` type */
 export const isSymbol = (x) => type(x) === 'symbol';
+/** Check if value is a `Set` type. */
+export const isSet = (x) => x instanceof Set;
+/** Check if value is a `Map` type. */
+export const isMap = (x) => x instanceof Map;
+/** Check if value is a `WeakSet` type. */
+export const isWeakSet = (x) => x instanceof WeakSet;
+/** Check if value is a `WeakMap` type. */
+export const isWeakMap = (x) => x instanceof WeakMap;
 /**
  * Returns the number of elements in a collection type.
  *
@@ -182,7 +205,7 @@ export function len(value) {
     if (isNumber(value.length)) {
         return value.length;
     }
-    if (isFunc(value.size)) {
+    if (isFunction(value.size)) {
         return value.size();
     }
     if (isNumber(value.size)) {
@@ -229,7 +252,7 @@ export const uuid = () => {
  * @return `obj.key(...args)` or `undefined`.
  */
 export function call(obj, key, ...args) {
-    if (isFunc(get(key, obj))) {
+    if (isFunction(get(key, obj))) {
         return obj[key](...args);
     }
 }

package/core/globals/index.ts

@@ -5,7 +5,7 @@
  */
 
 /** This is just a noop function. */
-export const _ = () => {}
+export const noop = () => {}
 
 /**
  * A generic function type with arbitrary arguments and return.
@@ -142,15 +142,25 @@ export function type(value) {
  */
 export const str = (obj) => (obj != null ? obj.toString() : '')
 
+export function hasOwnProperty(obj, prop) {
+  return Object.prototype.hasOwnProperty.call(obj, prop)
+}
+
 /** Check if value is a boolean type. */
 export const isBool = (x): x is boolean => type(x) === 'boolean'
 
+/** Check if value is an `Error` type. */
+export const isError = (x): x is Error => x instanceof Error
+
 /** Check if value is an iterable type. */
 export const isIterable = (x): x is IterableIterator<any> => {
   if (x == null) return false
   return typeof x[Symbol.iterator] === 'function'
 }
 
+/** Check if value is a native `Date` type. */
+export const isDate = (x): x is Date => x instanceof Date
+
 /** Check if value is an object type. */
 export const isObject = (x): x is Object => typeof x === 'object' && type(x) === 'object'
 
@@ -169,12 +179,12 @@ export const isArrayLike = (x) => {
   return T === 'array' || (T === 'object' && isNumber(x.length))
 }
 
-/** Check if value is a function type. */
-export const isFunc = (x): x is Function => x?.constructor === Function
-
 /** Check if value is a number type. */
 export const isNumber = (x): x is number => type(x) === 'number'
 
+/** Check if value is an integer number type. */
+export const isInteger = (x): x is number => type(x) === 'number' && Math.floor(x) === x
+
 /** Check if value is a bigint type. */
 export const isBigint = (x): x is BigInt => type(x) === 'bigint'
 
@@ -184,8 +194,11 @@ export const isNaN = (x): x is typeof NaN => Number.isNaN(x)
 /** Check if value is a Promise type. */
 export const isPromise = (x): x is Promise<any> => type(x) === 'Promise'
 
+/** Check if value is a function type. */
+export const isFunction = (x): x is Function => x?.constructor === Function
+
 /** Check if value is an async function type. */
-export const isAsync = (x) => x?.constructor.name === 'AsyncFunction'
+export const isAsyncFunction = (x) => x?.constructor.name === 'AsyncFunction'
 
 /** Check if value is a generator function type. */
 export const isGenerator = (x): x is Generator => {
@@ -195,15 +208,35 @@ export const isGenerator = (x): x is Generator => {
 /** Check if value is `null` or `undefined`. */
 export const isNull = (x): x is null | undefined => x == null
 
+/** Check if value === `undefined`. */
+export function isUndefined(o) {
+  return typeof o === 'undefined'
+}
+
 /** Check if value is not `null` or `undefined`. */
 export const notNull = (x) => x != null
 
 /** Returns `true` for objects without length or falsy values. */
 export const isEmpty = (x) => (len(x) === 0 ? true : !x)
 
+/** Check if value is a `RegExp` type */
+export const isRegExp = (x): x is RegExp => x instanceof RegExp
+
 /** Check if value is a `Symbol` type */
 export const isSymbol = (x): x is symbol => type(x) === 'symbol'
 
+/** Check if value is a `Set` type. */
+export const isSet = <T>(x): x is Set<T> => x instanceof Set
+
+/** Check if value is a `Map` type. */
+export const isMap = <K, V>(x): x is Map<K, V> => x instanceof Map
+
+/** Check if value is a `WeakSet` type. */
+export const isWeakSet = <T extends object>(x): x is WeakSet<T> => x instanceof WeakSet
+
+/** Check if value is a `WeakMap` type. */
+export const isWeakMap = <K extends object, V>(x): x is WeakMap<K, V> => x instanceof WeakMap
+
 /**
  * Returns the number of elements in a collection type.
  *
@@ -217,7 +250,7 @@ export function len(value) {
   if (isNumber(value.length)) {
     return value.length
   }
-  if (isFunc(value.size)) {
+  if (isFunction(value.size)) {
     return value.size()
   }
   if (isNumber(value.size)) {
@@ -267,7 +300,7 @@ export const uuid = () => {
  * @return `obj.key(...args)` or `undefined`.
  */
 export function call(obj: any, key: PropertyKey, ...args: any[]) {
-  if (isFunc(get(key, obj))) {
+  if (isFunction(get(key, obj))) {
     return obj[key](...args)
   }
 }

package/core/i18n/date/format.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns a new Date from the given arguments.
+ * @param {string | number | Date} date The date value
+ * @param {?boolean} [utc=false] Interprets the given value as a UTC date
+ * @returns {Date} The new date object
+ */
+export declare function getDate(date: string | number | Date, utc?: boolean): Date;
+/**
+ * Formats a date using a formatting string in the {@link https://strftime.org/ strftime} format, in any given locale.
+ * @param {string} fmt The format string to apply
+ * @param {number | Date} date The date value
+ * @param {?string} locale The locale to use when formatting (default is system locale).
+ * @returns {string} The string representation of date
+ * @see {@link https://strftime.org/ strftime format}
+ */
+export declare function format(fmt: string, date: number | Date, locale?: any): string;

package/core/i18n/date/format.js

@@ -0,0 +1,307 @@
+const NATIVE_DATE = /^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/;
+/**
+ * Returns a new Date from the given arguments.
+ * @param {string | number | Date} date The date value
+ * @param {?boolean} [utc=false] Interprets the given value as a UTC date
+ * @returns {Date} The new date object
+ */
+export function getDate(date, utc = false) {
+    if (date === null)
+        return new Date(NaN);
+    if (!date)
+        return new Date();
+    if (date instanceof Date)
+        return new Date(date);
+    if (typeof date === 'string' && !/Z$/i.test(date)) {
+        const d = date.match(NATIVE_DATE);
+        if (d) {
+            const m = d[2] - 1 || 0;
+            const ms = (d[7] || '0').slice(0, 3);
+            if (utc) {
+                return new Date(Date.UTC(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms));
+            }
+            return new Date(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms);
+        }
+    }
+    return new Date(date);
+}
+const n = 'numeric', s = 'short', l = 'long', dd = '2-digit', TOKEN_MAP = {
+    // weekday
+    '%A': { weekday: l },
+    '%a': { weekday: s },
+    '%aa': { weekday: n },
+    // day
+    '%d': { day: dd },
+    '%-d': { day: n },
+    // month
+    '%m': { month: dd },
+    '%-m': { month: n },
+    '%B': { month: l },
+    '%b': { month: s },
+    '%bb': { month: n },
+    // year
+    '%y': { year: n },
+    '%Y': { year: dd },
+    // hour
+    '%K': { hourCycle: 'h11', hour: dd },
+    '%I': { hourCycle: 'h12', hour: dd },
+    '%-I': { hourCycle: 'h12', hour: n },
+    '%H': { hourCycle: 'h23', hour: dd },
+    '%-H': { hourCycle: 'h23', hour: n },
+    '%k': { hourCycle: 'h24', hour: n },
+    // minutes
+    '%M': { minute: dd },
+    '%-M': { minute: n },
+    // seconds
+    '%S': { second: dd },
+    '%-S': { second: n },
+    // day period
+    '%P': { dayPeriod: l },
+    '%p': { dayPeriod: s },
+    '%pp': { dayPeriod: 'narrow' },
+    // era
+    '%N': { era: l, year: dd },
+    '%n': { era: s, year: dd },
+    '%nn': { era: n, year: 'narrow' },
+    // timeZoneName
+    '%Z': { timeZoneName: 'longGeneric', year: dd },
+    '%-Z': { timeZoneName: 'shortGeneric', year: dd },
+    '%z': { timeZoneName: 'longOffset', year: dd },
+    '%-z': { timeZoneName: 'shortOffset', year: dd },
+    '%ZZ': { timeZoneName: l, year: dd },
+    '%-ZZ': { timeZoneName: s, year: dd }
+};
+const HOUR_PARTS = { '%I': 1, '%-I': 1, '%K': 1, '%k': 1 };
+const ERA_PARTS = { '%n': 1, '%N': 1, '%nn': 1 };
+const TZ_PARTS = { '%ZZ': 1, '%-ZZ': 1, '%-z': 1, '%z': 1, '%-Z': 1, '%Z': 1 };
+const formatter = (locale, opts) => new Intl.DateTimeFormat(locale, opts);
+/**
+ * Formats a date using a formatting string in the {@link https://strftime.org/ strftime} format, in any given locale.
+ * @param {string} fmt The format string to apply
+ * @param {number | Date} date The date value
+ * @param {?string} locale The locale to use when formatting (default is system locale).
+ * @returns {string} The string representation of date
+ * @see {@link https://strftime.org/ strftime format}
+ */
+export function format(fmt, date, locale) {
+    let results = [], dayPeriod = '', dayPeriodIndex = -1;
+    for (let i = 0; i < fmt.length; i++) {
+        let part = fmt[i];
+        if (part === '%') {
+            // check for escaped '%'
+            if (fmt[++i] == '%') {
+                results.push('%');
+                continue;
+            }
+            if (fmt[i] === '-') {
+                part += fmt[i++];
+            }
+            part += fmt[i];
+            // add any repeated characters that come after
+            while (i < fmt.length - 1 && fmt[i + 1] === fmt[i])
+                part += fmt[++i];
+            if (HOUR_PARTS[part]) {
+                let res = formatter(locale, TOKEN_MAP[part]).format(date).split(' ');
+                // save the AM/PM for the correct spot
+                results.push(res[0]);
+                dayPeriod = res[1];
+                continue;
+            }
+            if (part === '%P' || part === '%p') {
+                // leave this flag in place for later
+                dayPeriodIndex = results.length;
+                results.push(part);
+                continue;
+            }
+            if (ERA_PARTS[part] || TZ_PARTS[part]) {
+                // the formatting includes the date/year so we take what comes after
+                let res = formatter(locale, TOKEN_MAP[part]).format(date).split(' ');
+                results.push(res.slice(1).join(' '));
+                continue;
+            }
+            // format any other parts
+            let res = formatter(locale, TOKEN_MAP[part]).format(date);
+            if (part === '%S' && res.length === 1)
+                res = '0' + res;
+            results.push(res);
+        }
+        else {
+            // output as literal
+            results.push(part);
+        }
+    }
+    // insert the AM/PM at the correct spot
+    if (dayPeriodIndex >= 0)
+        results[dayPeriodIndex] = dayPeriod || '';
+    return results.join('');
+}
+const DATETIME_DEFAULT = {};
+/** 10/14/1983 */
+const DATE_SHORT = {
+    year: n,
+    month: n,
+    day: n
+};
+/** Oct 14, 1983 */
+const DATE_MED = {
+    year: n,
+    month: s,
+    day: n
+};
+/** Fri, Oct 14, 1983 */
+const DATE_MED_WITH_WEEKDAY = {
+    year: n,
+    month: s,
+    day: n,
+    weekday: s
+};
+/** October 14, 1983 */
+const DATE_FULL = {
+    year: n,
+    month: l,
+    day: n
+};
+/** Tuesday, October 14, 1983 */
+const DATE_HUGE = {
+    year: n,
+    month: l,
+    day: n,
+    weekday: l
+};
+/** 09:30 AM */
+const TIME_SIMPLE = {
+    hour: n,
+    minute: n
+};
+/** 09:30:23 AM */
+const TIME_WITH_SECONDS = {
+    hour: n,
+    minute: n,
+    second: n
+};
+/** 09:30:23 AM EDT */
+const TIME_WITH_SHORT_OFFSET = {
+    hour: n,
+    minute: n,
+    second: n,
+    timeZoneName: s
+};
+/** 09:30:23 AM Eastern Daylight Time */
+const TIME_WITH_LONG_OFFSET = {
+    hour: n,
+    minute: n,
+    second: n,
+    timeZoneName: l
+};
+/** 09:30 */
+const TIME_24_SIMPLE = {
+    hour: n,
+    minute: n,
+    hourCycle: 'h23'
+};
+/** 09:30:23 */
+const TIME_24_WITH_SECONDS = {
+    hour: n,
+    minute: n,
+    second: n,
+    hourCycle: 'h23'
+};
+/** 09:30:23 EDT */
+const TIME_24_WITH_SHORT_OFFSET = {
+    hour: n,
+    minute: n,
+    second: n,
+    hourCycle: 'h23',
+    timeZoneName: s
+};
+/** 09:30:23 Eastern Daylight Time */
+const TIME_24_WITH_LONG_OFFSET = {
+    hour: n,
+    minute: n,
+    second: n,
+    hourCycle: 'h23',
+    timeZoneName: l
+};
+/** 10/14/1983, 9:30 AM */
+const DATETIME_SHORT = {
+    year: n,
+    month: n,
+    day: n,
+    hour: n,
+    minute: n
+};
+/** 10/14/1983, 9:30:33 AM */
+const DATETIME_SHORT_WITH_SECONDS = {
+    year: n,
+    month: n,
+    day: n,
+    hour: n,
+    minute: n,
+    second: n
+};
+/** Oct 14, 1983, 9:30 AM */
+const DATETIME_MED = {
+    year: n,
+    month: s,
+    day: n,
+    hour: n,
+    minute: n
+};
+/** Oct 14, 1983, 9:30:33 AM */
+const DATETIME_MED_WITH_SECONDS = {
+    year: n,
+    month: s,
+    day: n,
+    hour: n,
+    minute: n,
+    second: n
+};
+/** Fri, 14 Oct 1983, 9:30 AM */
+const DATETIME_MED_WITH_WEEKDAY = {
+    year: n,
+    month: s,
+    day: n,
+    weekday: s,
+    hour: n,
+    minute: n
+};
+/** October 14, 1983, 9:30 AM EDT */
+const DATETIME_FULL = {
+    year: n,
+    month: l,
+    day: n,
+    hour: n,
+    minute: n,
+    timeZoneName: s
+};
+/** October 14, 1983, 9:30:33 AM EDT */
+const DATETIME_FULL_WITH_SECONDS = {
+    year: n,
+    month: l,
+    day: n,
+    hour: n,
+    minute: n,
+    second: n,
+    timeZoneName: s
+};
+/** Friday, October 14, 1983, 9:30 AM Eastern Daylight Time */
+const DATETIME_HUGE = {
+    year: n,
+    month: l,
+    day: n,
+    weekday: l,
+    hour: n,
+    minute: n,
+    timeZoneName: l
+};
+/** Friday, October 14, 1983, 9:30:33 AM Eastern Daylight Time */
+const DATETIME_HUGE_WITH_SECONDS = {
+    year: n,
+    month: l,
+    day: n,
+    weekday: l,
+    hour: n,
+    minute: n,
+    second: n,
+    timeZoneName: l
+};