@talismn/util 0.5.6 → 0.5.8

package/dist/declarations/src/getQuery.d.ts

@@ -1,45 +0,0 @@
-import { Observable } from "rxjs";
-export type QueryStatus = "loading" | "loaded" | "error";
-export type QueryResult<T, S extends QueryStatus = "loading" | "loaded" | "error"> = S extends "loading" ? {
-    status: "loading";
-    data: T | undefined;
-    error: undefined;
-} : S extends "loaded" ? {
-    status: "loaded";
-    data: T;
-    error: undefined;
-} : {
-    status: "error";
-    data: undefined;
-    error: unknown;
-};
-type QueryOptions<Output, Args> = {
-    namespace: string;
-    args: Args;
-    queryFn: (args: Args, signal: AbortSignal) => Promise<Output>;
-    defaultValue?: Output;
-    refreshInterval?: number;
-    serializer?: (args: Args) => string;
-};
-/**
- * Creates a shared observable for executing queries with caching, loading states, and automatic refresh capabilities.
- *
- * @example
- * ```typescript
- * const userQuery$ = getQuery$({
- *   namespace: 'users',
- *   args: { userId: 123 },
- *   queryFn: async ({ userId }) => fetchUser(userId),
- *   defaultValue: null,
- *   refreshInterval: 30000
- * });
- *
- * userQuery$.subscribe(result => {
- *   if (result.status === 'loaded') {
- *     console.log(result.data);
- *   }
- * });
- * ```
- */
-export declare const getQuery$: <Output, Args>({ namespace, args, queryFn, defaultValue, refreshInterval, serializer, }: QueryOptions<Output, Args>) => Observable<QueryResult<Output>>;
-export {};

package/dist/declarations/src/getSharedObservable.d.ts

@@ -1,13 +0,0 @@
-import { Observable } from "rxjs";
-/**
- * When using react-rxjs hooks and state observables, the options are used as weak map keys.
- * This means that if the options object is recreated on each render, the observable will be recreated as well.
- * This utility function allows you to create a shared observable based on a namespace and arguments that, so react-rxjs can reuse the same observables
- *
- * @param namespace
- * @param args
- * @param createObservable
- * @param serializer
- * @returns
- */
-export declare const getSharedObservable: <Args, Output, ObsOutput = Observable<Output>>(namespace: string, args: Args, createObservable: (args: Args) => ObsOutput, serializer?: (args: Args) => string) => ObsOutput;

package/dist/declarations/src/hasOwnProperty.d.ts

@@ -1 +0,0 @@
-export declare function hasOwnProperty<X, Y extends PropertyKey>(obj: X, prop: Y): obj is X & Record<Y, unknown>;

package/dist/declarations/src/index.d.ts

@@ -1,31 +0,0 @@
-export * from "./addTrailingSlash";
-export * from "./BigMath";
-export * from "./classNames";
-export * from "./deferred";
-export * from "./firstThenDebounce";
-export * from "./formatDecimals";
-export * from "./formatPrice";
-export * from "./FunctionPropertyNames";
-export * from "./getSharedObservable";
-export * from "./hasOwnProperty";
-export * from "./isAbortError";
-export * from "./isArrayOf";
-export * from "./isAscii";
-export * from "./isBigInt";
-export * from "./isBooleanTrue";
-export * from "./isHexString";
-export * from "./isNotNil";
-export * from "./isPromise";
-export * from "./isSubject";
-export * from "./isTruthy";
-export * from "./keepAlive";
-export * from "./planckToTokens";
-export * from "./Prettify";
-export * from "./replaySubjectFrom";
-export * from "./sleep";
-export * from "./splitSubject";
-export * from "./throwAfter";
-export * from "./tokensToPlanck";
-export * from "./validateHexString";
-export * from "./getLoadable";
-export * from "./getQuery";

package/dist/declarations/src/isAbortError.d.ts

@@ -1 +0,0 @@
-export declare const isAbortError: (error: unknown) => boolean;

package/dist/declarations/src/isArrayOf.d.ts

@@ -1 +0,0 @@
-export declare function isArrayOf<T, P extends Array<unknown>>(array: unknown[], func: new (...args: P) => T): array is T[];

package/dist/declarations/src/isAscii.d.ts

@@ -1 +0,0 @@
-export declare const isAscii: (str: string) => boolean;

package/dist/declarations/src/isBigInt.d.ts

@@ -1 +0,0 @@
-export declare const isBigInt: (value: unknown) => value is bigint;

package/dist/declarations/src/isBooleanTrue.d.ts

@@ -1 +0,0 @@
-export declare const isBooleanTrue: <T>(x: T | null | undefined) => x is T;

package/dist/declarations/src/isHexString.d.ts

@@ -1,3 +0,0 @@
-export type HexString = `0x${string}`;
-export declare const REGEX_HEX_STRING: RegExp;
-export declare const isHexString: (value: unknown) => value is HexString;

package/dist/declarations/src/isNotNil.d.ts

@@ -1,9 +0,0 @@
-/**
- * WARNING: This function only checks against null or undefined, it does not coerce the value.
- * ie: false and 0 are considered not nil
- * Use isTruthy instead for a regular coercion check.
- *
- * @param value
- * @returns whether the value is neither null nor undefined
- */
-export declare const isNotNil: <T>(value: T | null | undefined) => value is T;

package/dist/declarations/src/isPromise.d.ts

@@ -1 +0,0 @@
-export declare const isPromise: <T = any>(value: any) => value is Promise<T>;

package/dist/declarations/src/isSubject.d.ts

@@ -1,5 +0,0 @@
-import { Subject } from "rxjs";
-/**
- * Tests to see if an object is an RxJS {@link Subject}.
- */
-export declare function isSubject<T>(object?: Subject<T> | object): object is Subject<T>;

package/dist/declarations/src/isTruthy.d.ts

@@ -1 +0,0 @@
-export declare const isTruthy: <T>(value: T | null | undefined) => value is T;

package/dist/declarations/src/keepAlive.d.ts

@@ -1,17 +0,0 @@
-import type { OperatorFunction } from "rxjs";
-/**
- * An RxJS operator that keeps the source observable alive for a specified duration
- * after all subscribers have unsubscribed. This prevents expensive re-subscriptions
- * when subscribers come and go frequently.
- *
- * @param keepAliveMs - Duration in milliseconds to keep the source alive after last unsubscription
- * @returns MonoTypeOperatorFunction that can be used in pipe()
- *
- * @example
- * ```typescript
- * const data$ = expensive_api_call$.pipe(
- *   keepAlive(3000) // Keep alive for 3 seconds
- * );
- * ```
- */
-export declare const keepAlive: <T>(timeout: number) => OperatorFunction<T, T>;

package/dist/declarations/src/planckToTokens.d.ts

@@ -1,3 +0,0 @@
-export declare function planckToTokens(planck: string, tokenDecimals: number): string;
-export declare function planckToTokens(planck: string, tokenDecimals?: number): string | undefined;
-export declare function planckToTokens(planck?: string, tokenDecimals?: number): string | undefined;

package/dist/declarations/src/replaySubjectFrom.d.ts

@@ -1,12 +0,0 @@
-import { ReplaySubject } from "rxjs";
-/**
- * Turns a value into a {@link ReplaySubject} of size 1.
- *
- * If the value is already a {@link ReplaySubject}, it will be returned as-is.
- *
- * If the value is a {@link Promise}, it will be awaited,
- * and the awaited value will be published into the {@link ReplaySubject} when it becomes available.
- *
- * For any other type of value, it will be immediately published into the {@link ReplaySubject}.
- */
-export declare const replaySubjectFrom: <T>(initialValue: T | Promise<T> | ReplaySubject<T>) => ReplaySubject<T>;

package/dist/declarations/src/sleep.d.ts

@@ -1 +0,0 @@
-export declare const sleep: (ms: number) => Promise<void>;

package/dist/declarations/src/splitSubject.d.ts

@@ -1,11 +0,0 @@
-import { Observable, Subject } from "rxjs";
-/**
- * Takes a subject and splits it into two parts:
- *
- * 1. A function to submit new values into the subject.
- * 2. An observable for subscribing to new values from the subject.
- *
- * This can be helpful when, to avoid bugs, you want to expose only one
- * of these parts to external code and keep the other part private.
- */
-export declare function splitSubject<T>(subject: Subject<T>): readonly [(value: T) => void, Observable<T>];

package/dist/declarations/src/throwAfter.d.ts

@@ -1 +0,0 @@
-export declare const throwAfter: (ms: number, reason: string) => Promise<never>;

package/dist/declarations/src/tokensToPlanck.d.ts

@@ -1,3 +0,0 @@
-export declare function tokensToPlanck(tokens: string, tokenDecimals: number): string;
-export declare function tokensToPlanck(tokens: string, tokenDecimals?: number): string | undefined;
-export declare function tokensToPlanck(tokens?: string, tokenDecimals?: number): string | undefined;

package/dist/declarations/src/validateHexString.d.ts

@@ -1,11 +0,0 @@
-/**
- * @name validateHexString
- * @description Checks if a string is a hex string. Required to account for type differences between different polkadot libraries
- * @param {string} str - string to check
- * @returns {`0x${string}`} - boolean
- * @example
- * validateHexString("0x1234") // "0x1234"
- * validateHexString("1234") // Error: Expected a hex string
- * validateHexString(1234) // Error: Expected a string
- **/
-export declare const validateHexString: (str: string) => `0x${string}`;

package/dist/talismn-util.cjs.d.ts

@@ -1 +0,0 @@
-export * from "./declarations/src/index";