@pistonite/pure 0.26.6 → 0.26.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pistonite/pure",
-  "version": "0.26.6",
+  "version": "0.26.8",
   "type": "module",
   "description": "Pure TypeScript libraries for my projects",
   "homepage": "https://github.com/Pistonite/pure",

package/src/log/index.ts

@@ -5,6 +5,8 @@ export {
     logger,
     type LoggerFactory,
     type Logger,
+    resettableLogger,
+    type ResettableLogger,
 } from "./logger.ts";
 export {
     internalLogOff,

package/src/log/internal.ts

@@ -1,18 +1,14 @@
-import { LoggerImpl, LogLevel } from "./logger.ts";
+import { resettableLogger } from "./logger.ts";
 
-export const ilog: LoggerImpl = new LoggerImpl("pure", "gray", LogLevel.High);
+const { logger, off, debug, info } = resettableLogger("pure", "gray");
+
+export const ilog = logger;
 
 /** Set the internal log level of calls in this library to off */
-export const internalLogOff = () => {
-    ilog.level = LogLevel.Off;
-};
+export const internalLogOff = off;
 
 /** Set the internal log level of calls in this library to debug */
-export const internalLogDebug = () => {
-    ilog.level = LogLevel.Debug;
-};
+export const internalLogDebug = debug;
 
 /** Set the internal log level of calls in this library to info */
-export const internalLogInfo = () => {
-    ilog.level = LogLevel.Info;
-};
+export const internalLogInfo = info;

package/src/log/logger.ts

@@ -37,19 +37,25 @@ let globalLevel: LogLevel = LogLevel.High;
  *
  * This overrides logger-level settings
  */
-export const globalLogOff = () => (globalLevel = 0);
+export const globalLogOff = () => {
+    globalLevel = LogLevel.Off;
+};
 /**
  * Enable +info logging for ALL loggers
  *
  * This overrides logger-level settings
  */
-export const globalLogInfo = () => (globalLevel = 2);
+export const globalLogInfo = () => {
+    globalLevel = LogLevel.Info;
+};
 /**
  * Enable +debug logging for ALL loggers
  *
  * This overrides logger-level settings
  */
-export const globalLogDebug = () => (globalLevel = 3);
+export const globalLogDebug = () => {
+    globalLevel = LogLevel.Debug;
+};
 
 /** Create a logger creator. Use the factory methods to finish making the logger */
 export const logger = (name: string, color?: string): LoggerFactory => {
@@ -61,6 +67,31 @@ export const logger = (name: string, color?: string): LoggerFactory => {
     };
 };
 
+/** Create a {@link ResettableLogger} that can be easily reconfigured */
+export const resettableLogger = (
+    name: string,
+    color?: string,
+): ResettableLogger => {
+    const logger = new LoggerImpl(name, color, LogLevel.High);
+    return {
+        logger,
+        debug: () => (logger.level = LogLevel.Debug),
+        info: () => (logger.level = LogLevel.Info),
+        off: () => (logger.level = LogLevel.Off),
+    };
+};
+
+/**
+ * A logger whose level can be changed later. Useful for libraries to expose,
+ * so users can easily debug calls in the library
+ */
+export type ResettableLogger = {
+    logger: Logger;
+    debug(): void;
+    info(): void;
+    off(): void;
+};
+
 export type LoggerFactory = {
     /** Standard important logger (warning and errors) */
     default(): Logger;

package/src/sync/index.ts

@@ -14,8 +14,9 @@ export { latest, type LatestConstructor, type UpdateArgsFn } from "./latest.ts";
 export { debounce, type DebounceConstructor } from "./debounce.ts";
 export { batch, type BatchConstructor } from "./batch.ts";
 export { once, type OnceConstructor } from "./once.ts";
+export { makePromise, type PromiseHandle } from "./util.ts";
 
-// types
+// helper types
 export type { AnyFn, AwaitRet } from "./util.ts";
 
 // unstable

package/src/sync/util.ts

@@ -1,23 +1,28 @@
-export const makePromise = <T>(): {
-    promise: Promise<T>;
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason?: unknown) => void;
-} => {
-    let resolve;
-    let reject;
+/**
+ * Make a {@link PromiseHandle} with the promise object separate from
+ * its resolve and reject methods
+ */
+export const makePromise = <T>(): PromiseHandle<T> => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let resolve: any;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let reject: any;
     const promise = new Promise<T>((res, rej) => {
         resolve = res;
         reject = rej;
     });
-    if (!resolve || !reject) {
-        throw new Error(
-            "Promise callbacks not set. This is a bug in the JS engine!",
-        );
-    }
     return { promise, resolve, reject };
 };
 
-export type PromiseHandle<T> = ReturnType<typeof makePromise<T>>;
+/**
+ * A handle of the promise that breaks down the promise object
+ * and its resolve and reject functions
+ */
+export type PromiseHandle<T> = {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: unknown) => void;
+};
 
 /** Shorthand for Awaited<ReturnType<T>> */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any