atomic-fns 0.2.2 → 0.3.0

package/src/functools.js

@@ -1,78 +0,0 @@
-export const bind = (fn, self, ...args) => fn.bind(self, ...args)
-export const partial = (fn, ...args) => bind(fn, {}, ...args)
-export const flow =
-  (...args) =>
-  (x) => {
-    for (const fn of args) {
-      x = fn(x)
-    }
-    return x
-  }
-export const pipe = flow
-export const compose = (...args) => flow(args.reverse())
-/**
- * Creates a function that memoizes the result of `func`. If `resolver` is provided, it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is used as the map cache key.
- *
- *
- * @param {Function} func The function to have its output memoized.
- * @param {Function} [resolver] The function to resolve the cache key.
- * @return {Function} Returns the new memoized function.
- */
-export function memoize(func, resolver) {
-  const cache = new Map()
-  return (...args) => {
-    const key = resolver ? resolver(...args) : args[0]
-    const prev = cache.get(key)
-    if (prev !== undefined) return prev
-    const value = func(...args)
-    cache.set(key, value)
-    return value
-  }
-}
-/**
- * Creates a debounced function that delays invoking `func` until after `wait` milliseconds have elapsed since the last time the debounced function was invoked. Subsequent calls to the debounced function return the result of the last successful invocation. Provide options to set the `maxWait` milliseconds, regardless of when the function was last invoked.
- *
- *
- * @param {Function} func The function to debounce.
- * @param {number} wait The number of milliseconds to delay.
- * @param {{ maxWait: number }} { maxWait } The maximum time `func` is allowed to be delayed before it's invoked.
- * @return {Function} Returns the new debounced function.
- */
-export function debounce(func, wait, { maxWait }) {
-  let timer, maxTimer, lastResult
-  return (...args) => {
-    if (timer) clearTimeout(timer)
-    timer = setTimeout(() => {
-      clearTimeout(maxTimer)
-      maxTimer = null
-      lastResult = func(...args)
-    }, wait)
-    if (maxWait && !maxTimer) {
-      maxTimer = setTimeout(() => {
-        clearTimeout(timer)
-        maxTimer = null
-        lastResult = func(...args)
-      }, maxWait)
-    }
-    return lastResult
-  }
-}
-/**
- * Creates a throttled function that only invokes `func` at most once per every `wait` milliseconds. Subsequent calls to the throttled function return the result of the last successful invocation.
- *
- *
- * @param {Function} func The function to throttle.
- * @param {number} time The number of milliseconds to throttle invocations to.
- * @return {Function} Returns the new throttled function.
- */
-export function throttle(func, time) {
-  let pending = false
-  return (...args) => {
-    if (pending) return
-    func(...args)
-    pending = true
-    setTimeout(() => {
-      pending = false
-    }, time)
-  }
-}

package/src/functools.ts

@@ -1,93 +0,0 @@
-/**
- * FP
- * @module
- */
-import { Function } from './globals.js'
-
-export const bind = (fn, self, ...args) => fn.bind(self, ...args)
-
-export const partial = (fn, ...args) => bind(fn, {}, ...args)
-
-export const flow =
-  (...args) =>
-  (x: any) => {
-    for (const fn of args) {
-      x = fn(x)
-    }
-    return x
-  }
-
-export const pipe = flow
-
-export const compose = (...args) => flow(args.reverse())
-
-/**
- * Creates a function that memoizes the result of `func`. If `resolver` is provided, it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is used as the map cache key.
- *
- *
- * @param {Function} func The function to have its output memoized.
- * @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 {
-  const cache = new Map()
-  return (...args) => {
-    const key = resolver ? resolver(...args) : args[0]
-    const prev = cache.get(key)
-    if (prev !== undefined) return prev
-    const value = func(...args)
-    cache.set(key, value)
-    return value
-  }
-}
-
-/**
- * Creates a debounced function that delays invoking `func` until after `wait` milliseconds have elapsed since the last time the debounced function was invoked. Subsequent calls to the debounced function return the result of the last successful invocation. Provide options to set the `maxWait` milliseconds, regardless of when the function was last invoked.
- *
- *
- * @param {Function} func The function to debounce.
- * @param {number} wait The number of milliseconds to delay.
- * @param {{ maxWait: number }} { maxWait } The maximum time `func` is allowed to be delayed before it's invoked.
- * @return {Function} Returns the new debounced function.
- */
-export function debounce(func: Function, wait: number, { maxWait }: { maxWait: number }): Function {
-  let timer, maxTimer, lastResult
-  return (...args) => {
-    if (timer) clearTimeout(timer)
-    timer = setTimeout(() => {
-      clearTimeout(maxTimer)
-      maxTimer = null
-      lastResult = func(...args)
-    }, wait)
-
-    if (maxWait && !maxTimer) {
-      maxTimer = setTimeout(() => {
-        clearTimeout(timer)
-        maxTimer = null
-        lastResult = func(...args)
-      }, maxWait)
-    }
-
-    return lastResult
-  }
-}
-
-/**
- * Creates a throttled function that only invokes `func` at most once per every `wait` milliseconds. Subsequent calls to the throttled function return the result of the last successful invocation.
- *
- *
- * @param {Function} func The function to throttle.
- * @param {number} time The number of milliseconds to throttle invocations to.
- * @return {Function} Returns the new throttled function.
- */
-export function throttle(func: Function, time: number): Function {
-  let pending = false
-  return (...args) => {
-    if (pending) return
-    func(...args)
-    pending = true
-    setTimeout(() => {
-      pending = false
-    }, time)
-  }
-}

package/src/globals.d.ts

@@ -1,179 +0,0 @@
-/**
- * Globals
- * @module
- */
-export declare type Comp = (x: any, y: any) => number;
-export declare type Function = (...args: any[]) => any;
-export declare type Iteratee = (value: any, key?: any, arr?: any) => any;
-export declare const True: () => boolean;
-export declare const False: () => boolean;
-/**
- * A custom error class that inherits from the Error object.
- *
- *
- * @class CustomError
- * @extends {Error}
- */
-export declare class CustomError extends Error {
-    /**
-     * Returns a new CustomError with the specified message.
-     * @param {string} message
-     * @constructor
-     */
-    constructor(message?: string);
-}
-/**
- * Custom error to signal an invalid index access.
- * @extends {CustomError}
- */
-export declare class IndexError extends CustomError {
-}
-/**
- * Raised when a system function returns an I/O failure such as "file not found"
- * or "disk full".
- * @extends {CustomError}
- */
-export declare class IOError extends CustomError {
-}
-/**
- * Custom error to signal an invalid key access.
- * @extends {CustomError}
- */
-export declare class KeyError extends CustomError {
-}
-/**
- * Custom error to signal an invalid operation.
- * @extends {CustomError}
- */
-export declare class NotImplementedError extends CustomError {
-}
-/**
- * Custom error to signal an invalid value.
- * @extends {CustomError}
- */
-export declare class ValueError extends CustomError {
-}
-/**
- * Raised when the second argument of a division or modulo operation is zero.
- * @extends {CustomError}
- */
-export declare class ZeroDivisionError extends CustomError {
-}
-/**
- * Returns the true type of any value with correct detection for null, Array,
- * Object, Promise, Symbol, and NaN.
- *
- *
- * @param {*} value
- * @return
- */
-export declare function type(value: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" | "promise" | "null" | "NaN";
-/** Same as `x.toString()`. Returns `''` when x is null or undefined */
-export declare const str: (x: any) => any;
-/** Check if value is a boolean type */
-export declare const isBool: (x: any) => boolean;
-/** Check if value is an object type */
-export declare const isObject: (x: any) => boolean;
-/** Check if value is a string type */
-export declare const isString: (x: any) => boolean;
-/** Check if value is an Array type */
-export declare const isArray: (x: any) => boolean;
-/** Check if value is Array-like type.
- * 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) => boolean;
-/** Check if value is a number type */
-export declare const isNumber: (x: any) => boolean;
-/** Check if value is a Bigint type */
-export declare const isBigint: (x: any) => boolean;
-/** Check if value is NaN based on `Number.isNaN` */
-export declare const isNaN: (x: any) => boolean;
-/** Check if value is a Promise type */
-export declare const isPromise: (x: any) => boolean;
-/** Check if value is an async function type */
-export declare const isAsync: (x: any) => boolean;
-/** Check if value is a generator function type */
-export declare const isGenerator: (x: any) => boolean;
-/** Check if value is null or undefined */
-export declare const isNull: (x: any) => boolean;
-/** Check if value is not null or undefined */
-export declare const notNull: (x: any) => boolean;
-export declare function len(x: any): any;
-/** Returns true for objects without length or falsey values. */
-export declare const isEmpty: (x: any) => boolean;
-/** Check if value is a Symbol type */
-export declare const isSymbol: (x: any) => boolean;
-/**
- * Generates a unique ID using random numbers.
- * If prefix is given, the ID is appended to it
- */
-export declare const uniqueId: (pre?: string) => any;
-/**
- * Checks if `obj.key` is a function, and calls it with any `args`.
- *
- *
- * @param {*} obj
- * @param {PropertyKey} key
- * @param {...any[]} args
- * @return `obj.key(...args)`
- */
-export declare function call(obj: any, key: PropertyKey, ...args: any[]): any;
-/** Convert number to unicode character */
-export declare const chr: (x: number) => string;
-/** Convert character to Unicode code point */
-export declare const ord: (x: string) => number;
-/** `Object.keys(x)` */
-export declare const keys: (x: any) => string[];
-/** `Object.values(x)` */
-export declare const values: (x: any) => unknown[];
-/**
- * Round `x` to the number of digits after the decimal point. If `digits` is
- * omitted, it returns the nearest integer to x.
- *
- * @param {number} x
- * @param {number} [digits=0]
- */
-export declare function round(x: number, digits?: number): number;
-export declare const floor: (x: number) => number;
-export declare const ceil: (x: number) => number;
-/**
- * Yields elements like `[index, item]` from an iterable.
- *
- *
- * @template T
- * @param {Iterable<T>} iterable
- */
-export declare function enumerate<T = unknown>(iterable: Iterable<T>): Generator<(number | T)[], void, unknown>;
-export declare const has: (obj: any, attr: PropertyKey) => any;
-/**
- * Check if the attribute is present in the object, or return optional default.
- *
- *
- * @param {*} obj
- * @param {PropertyKey} key
- * @param {*} [value=undefined]
- * @return The property value or default value
- */
-export declare function get(obj: any, key: PropertyKey | PropertyKey[], value?: any): any;
-export declare function del(x: any, attr: any): any;
-export declare function set(self: any, attr: PropertyKey, value: any, writable?: boolean, enumerable?: boolean): any;
-export declare const HASH_KEY: unique symbol;
-export declare function hash(obj: any): any;
-/**
- * A hash value generator for strings
- *
- * @param {string} str
- * @return {number}
- * @see http://isthe.com/chongo/tech/comp/fnv/
- */
-export declare function hashCode(str: string): number;
-export declare const bin: (n: number) => string;
-export declare const hex: (n: number) => string;
-export declare const oct: (n: number) => string;
-export declare const float: (x: any) => number;
-export declare const int: (x: any, base?: number) => number;
-export declare const list: (arr?: any) => unknown[];
-export declare const next: (iter: Iterator<unknown>) => any;

package/src/globals.js

@@ -1,309 +0,0 @@
-export const True = () => true
-export const False = () => false
-/**
- * A custom error class that inherits from the Error object.
- *
- *
- * @class CustomError
- * @extends {Error}
- */
-export class CustomError extends Error {
-  /**
-   * Returns a new CustomError with the specified message.
-   * @param {string} message
-   * @constructor
-   */
-  constructor(message) {
-    super(message)
-    this.name = this.constructor.name
-    if (typeof Error.captureStackTrace === 'function') {
-      Error.captureStackTrace(this, this.constructor)
-    } else {
-      this.stack = new Error(message).stack
-    }
-  }
-}
-/**
- * Custom error to signal an invalid index access.
- * @extends {CustomError}
- */
-export class IndexError extends CustomError {}
-/**
- * Raised when a system function returns an I/O failure such as "file not found"
- * or "disk full".
- * @extends {CustomError}
- */
-export class IOError extends CustomError {}
-/**
- * Custom error to signal an invalid key access.
- * @extends {CustomError}
- */
-export class KeyError extends CustomError {}
-/**
- * Custom error to signal an invalid operation.
- * @extends {CustomError}
- */
-export class NotImplementedError extends CustomError {}
-/**
- * Custom error to signal an invalid value.
- * @extends {CustomError}
- */
-export class ValueError extends CustomError {}
-/**
- * Raised when the second argument of a division or modulo operation is zero.
- * @extends {CustomError}
- */
-export class ZeroDivisionError extends CustomError {}
-/**
- * Returns the true type of any value with correct detection for null, Array,
- * Object, Promise, Symbol, and NaN.
- *
- *
- * @param {*} value
- * @return
- */
-export function type(value) {
-  const result = typeof value
-  if (result === 'object') {
-    if (value) {
-      if (value instanceof String) return 'string'
-      if (value instanceof Boolean) return 'boolean'
-      if (value instanceof Function) return 'function'
-      // IE improperly marshals typeof across execution contexts, but a
-      // cross-context object will still return false for "instanceof Object".
-      if (value instanceof Array) return 'array'
-      const className = str(value)
-      // In Firefox 3.6, attempting to access iframe window objects' length
-      // property throws an NS_ERROR_FAILURE, so we need to special-case it
-      // here.
-      if (className === '[object Window]') return 'object'
-      // We cannot always use constructor === Array or instanceof Array because
-      // different frames have different Array objects.
-      // Mark Miller noticed that Object.prototype.toString
-      // allows access to the unforgeable [[Class]] property.
-      //  15.2.4.2 Object.prototype.toString ( )
-      //  When the toString method is called, the following steps are taken:
-      //      1. Get the [[Class]] property of this object.
-      //      2. Compute a string value by concatenating the three strings
-      //         "[object ", Result(1), and "]".
-      //      3. Return Result(2).
-      // and this behavior survives the destruction of the execution context.
-      if (className.endsWith('Array]') || Array.isArray(value)) {
-        return 'array'
-      }
-      // HACK: There is still an array case that fails.
-      //     function ArrayImpostor() {}
-      //     ArrayImpostor.prototype = [];
-      //     var impostor = new ArrayImpostor;
-      // this can be fixed by getting rid of the fast path
-      // (value instanceof Array) and solely relying on
-      // (value && Object.prototype.toString.vall(value) === '[object Array]')
-      // but that would require many more function calls and is not warranted
-      // unless closure code is receiving objects from untrusted sources.
-      // IE in cross-window calls does not correctly marshal the function type
-      // (it appears just as an object) so we cannot use just typeof val ==
-      // 'function'. However, if the object has a call property, it is a
-      // function.
-      if (className.endsWith('Function]') || typeof value.call === 'function') {
-        return 'function'
-      }
-      if (className === '[object Promise]' || value instanceof Promise) {
-        return 'promise'
-      }
-      if (className === '[object Symbol]') {
-        return 'symbol'
-      }
-    } else {
-      return 'null'
-    }
-  } else if (result === 'function' && typeof value.call === 'undefined') {
-    // In Safari typeof nodeList returns 'function', and on Firefox typeof
-    // behaves similarly for HTML{Applet,Embed,Object}, Elements and RegExps. We
-    // would like to return object for those and we can detect an invalid
-    // function by making sure that the function object has a call method.
-    return 'object'
-  } else if (Number.isNaN(value)) return 'NaN'
-  return result
-}
-/** Same as `x.toString()`. Returns `''` when x is null or undefined */
-export const str = (x) => (x != null ? x.toString() : '')
-/** Check if value is a boolean type */
-export const isBool = (x) => type(x) === 'boolean'
-/** Check if value is an object type */
-export const isObject = (x) => typeof x === 'object' && type(x) === 'object'
-/** Check if value is a string type */
-export const isString = (x) => type(x) === 'string'
-/** Check if value is an Array type */
-export const isArray = (x) => type(x) === 'array'
-/** Check if value is Array-like type.
- * A value is considered array-like if it's not a function and has a
- * `.length` number property.
- */
-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 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 an async function type */
-export const isAsync = (x) => get(x, 'constructor.name') === 'AsyncFunction'
-/** Check if value is a generator function type */
-export const isGenerator = (x) => {
-  return get(x, 'constructor.constructor.name') === 'GeneratorFunction'
-}
-/** Check if value is null or undefined */
-export const isNull = (x) => x == null
-/** Check if value is not null or undefined */
-export const notNull = (x) => x != null
-export function len(x) {
-  if (x == null) return
-  if (x.length !== undefined) {
-    return x.length
-  }
-  if (isFunc(x.size)) {
-    return x.size()
-  }
-  if (isObject(x)) {
-    return Object.keys(x).length
-  }
-}
-/** Returns true for objects without length or falsey values. */
-export const isEmpty = (x) => (len(x) === 0 ? true : !x)
-/** Check if value is a Symbol type */
-export const isSymbol = (x) => type(x) === 'symbol'
-/**
- * Generates a unique ID using random numbers.
- * If prefix is given, the ID is appended to it
- */
-export const uniqueId = (pre = '') =>
-  // @ts-expect-error
-  (pre || 0) + ((Math.random() * 1e10) >>> 0)
-/**
- * Checks if `obj.key` is a function, and calls it with any `args`.
- *
- *
- * @param {*} obj
- * @param {PropertyKey} key
- * @param {...any[]} args
- * @return `obj.key(...args)`
- */
-export function call(obj, key, ...args) {
-  if (isFunc(get(obj, key))) {
-    return obj[key](...args)
-  }
-}
-/** Convert number to unicode character */
-export const chr = (x) => String.fromCodePoint(x)
-/** Convert character to Unicode code point */
-export const ord = (x) => x.charCodeAt(0)
-/** `Object.keys(x)` */
-export const keys = (x) => Object.keys(x)
-/** `Object.values(x)` */
-export const values = (x) => Object.values(x)
-/**
- * Round `x` to the number of digits after the decimal point. If `digits` is
- * omitted, it returns the nearest integer to x.
- *
- * @param {number} x
- * @param {number} [digits=0]
- */
-export function round(x, digits = 0) {
-  const base = 10 ** digits
-  return Math.round(x * base) / base
-}
-export const floor = (x) => Math.floor(x)
-export const ceil = (x) => Math.ceil(x)
-/**
- * Yields elements like `[index, item]` from an iterable.
- *
- *
- * @template T
- * @param {Iterable<T>} iterable
- */
-export function* enumerate(iterable) {
-  let i = 0
-  for (const item of iterable) {
-    yield [i++, item]
-  }
-}
-export const has = (obj, attr) => obj && attr in obj
-/**
- * Check if the attribute is present in the object, or return optional default.
- *
- *
- * @param {*} obj
- * @param {PropertyKey} key
- * @param {*} [value=undefined]
- * @return The property value or default value
- */
-export function get(obj, key, value = undefined) {
-  if (obj == null) return value
-  let paths = Array.isArray(key) ? key : [key]
-  if (typeof key === 'string') {
-    paths = key.split('.')
-  }
-  try {
-    let result = obj
-    for (const k of paths) {
-      result = result[k]
-    }
-    return result === undefined ? value : result
-  } catch (error) {
-    return value
-  }
-}
-export function del(x, attr) {
-  if (x != null) delete x[attr]
-  return x
-}
-export function set(self, attr, value, writable = false, enumerable = false) {
-  return Object.defineProperty(self, attr, {
-    value,
-    enumerable,
-    writable
-  })
-}
-export const HASH_KEY = Symbol.for('HASH_KEY')
-export function hash(obj) {
-  if (typeof obj === 'string') {
-    return hashCode(obj)
-  }
-  if (typeof obj === 'object') {
-    if (obj[HASH_KEY] == null) {
-      set(obj, HASH_KEY, uniqueId())
-    }
-    return obj[HASH_KEY]
-  }
-  return obj
-}
-/**
- * A hash value generator for strings
- *
- * @param {string} str
- * @return {number}
- * @see http://isthe.com/chongo/tech/comp/fnv/
- */
-export function hashCode(str) {
-  const FNV1_32A_INIT = 0x811c9dc5
-  let hval = FNV1_32A_INIT
-  for (let i = 0; i < str.length; ++i) {
-    hval ^= str.charCodeAt(i)
-    hval += (hval << 1) + (hval << 4) + (hval << 7) + (hval << 8) + (hval << 24)
-  }
-  return hval >>> 0
-}
-export const bin = (n) => n.toString(2)
-export const hex = (n) => n.toString(16)
-export const oct = (n) => n.toString(8)
-export const float = (x) => parseFloat(x)
-export const int = (x, base = 10) => parseInt(x, base)
-export const list = (arr) => (arr ? Array.from(arr) : [])
-export const next = (iter) => iter.next().value