@naturalcycles/js-lib 14.108.0 → 14.109.1

package/src/string/readingTime.ts

@@ -9,14 +9,26 @@ Reasons:
 
  */
 
+import type { Integer } from '../types'
+
 export interface ReadingTimeOptions {
+  /**
+   * A function that returns a boolean value depending on if a character is considered as a word bound.
+   * Default: spaces, new lines and tabs
+   */
   wordBound?: (char: string) => boolean
+  /**
+   * Default 200
+   */
   wordsPerMinute?: number
 }
 
 export interface ReadingTimeStats {
-  time: number
-  minutes: number
+  /**
+   * Number of milliseconds.
+   */
+  time: Integer
+  minutes: Integer
 }
 
 export interface WordCountStats {

package/src/string/safeJsonStringify.ts

@@ -1,4 +1,4 @@
-import { Reviver } from '../types'
+import type { Reviver } from '../types'
 
 /**
  * JSON.stringify that avoids circular references, prints them as [Circular ~]

package/src/string/stringifyAny.ts

@@ -1,5 +1,5 @@
 import { _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse } from '../error/error.util'
-import { Reviver } from '../types'
+import type { Reviver } from '../types'
 import { _jsonParseIfPossible } from './json.util'
 import { _safeJsonStringify } from './safeJsonStringify'
 

package/src/string/url.util.ts

@@ -1,4 +1,4 @@
-import { StringMap } from '../types'
+import type { StringMap } from '../types'
 
 /**
  * Parses `location.search` string (e.g `?a=1&b=2`) into a StringMap, e.g:

package/src/types.ts

@@ -1,4 +1,4 @@
-import { Except, Merge, Promisable } from './typeFest'
+import type { Except, Merge, Promisable } from './typeFest'
 
 /**
  * Map from String to String (or <T>).
@@ -243,27 +243,19 @@ export type Reviver = (this: any, key: string, value: any) => any
  * Needed due to https://github.com/microsoft/TypeScript/issues/13778
  * Only affects typings, no runtime effect.
  */
-export function _stringMapValues<T>(m: StringMap<T>): T[] {
-  return Object.values(m) as T[]
-}
+export const _stringMapValues = Object.values as <T>(m: StringMap<T>) => T[]
 
 /**
  * Needed due to https://github.com/microsoft/TypeScript/issues/13778
  * Only affects typings, no runtime effect.
  */
-export function _stringMapEntries<T>(m: StringMap<T>): [k: string, v: T][] {
-  return Object.entries(m) as [string, T][]
-}
+export const _stringMapEntries = Object.entries as <T>(m: StringMap<T>) => [k: string, v: T][]
 
 /**
  * Like `Object.keys`, but returns keys typed as `keyof T`, not as just `string`.
  * This is how TypeScript should work, actually.
- *
- * @experimental
  */
-export function _objectKeys<T extends AnyObject>(obj: T): (keyof T)[] {
-  return Object.keys(obj)
-}
+export const _objectKeys = Object.keys as <T extends AnyObject>(obj: T) => (keyof T)[]
 
 export type NullishValue = null | undefined
 export type FalsyValue = false | '' | 0 | null | undefined