df-script 1.6.0 → 1.7.0

package/dist/utils/list.d.ts

@@ -1,217 +0,0 @@
-export type ArrayItemType = "string" | "number" | "boolean" | "bigint" | "object" | "plainObject" | "date" | "any" | "null" | "undefined" | "nullish" | (new (...args: any[]) => any) | ((v: unknown) => boolean);
-export type ArrayCheckMode = "every" | "some";
-export type IsArrayOfTypeOptionsParams = {
-    mode?: ArrayCheckMode;
-    allowNulls?: boolean;
-    allowEmpty?: boolean;
-};
-export declare function toValidArray<T>(val: T | T[] | null | undefined): T[];
-export declare function toValidStringArray(val: unknown): string[];
-export declare function isArrayOfType(arr: unknown, type: ArrayItemType, { mode, allowNulls, allowEmpty }?: IsArrayOfTypeOptionsParams): boolean;
-export interface SortListOptions {
-    descending?: boolean;
-    nullsLast?: boolean;
-    isAllNumbers?: boolean;
-    isAllStrings?: boolean;
-    hasNulls?: boolean;
-}
-export declare function sortList(arr: unknown, options?: SortListOptions): any[];
-export declare function getListStats(arr: unknown): {
-    sum: number | null;
-    count: number;
-    min: any;
-    max: any;
-    mean: number | null;
-    variance: number;
-    std: number;
-    nullCount: number;
-    len: number;
-    hasNulls: boolean;
-    isNumeric: boolean;
-};
-/**
- * Options configuration for the `getUniqueListStats` utility.
- */
-export interface UniqueListStatsOptions {
-    /**
-     * If true, uses strict serialization comparison (via keySelector or toCanonicalString)
-     * to group complex nested types (like Arrays, Sets, Maps, and Dates) by value instead of reference.
-     * @default false
-     */
-    strict?: boolean;
-    /**
-     * Custom function to extract a unique comparison key from each element.
-     * If strict is true and no selector is provided, falls back to `toCanonicalString`.
-     */
-    keySelector?: (val: any) => any;
-}
-export declare function getUniqueListStats(arr: ArrayLike<any>, { strict, keySelector }?: UniqueListStatsOptions): {
-    values: any[];
-    count: number;
-    frequencies: Map<any, number>;
-};
-/**
- * Options configuration for the `stepSliceList` utility.
- */
-export interface StepSliceListOptions {
-    /**
-     * The step size to slice the list by. Cannot be zero.
-     * Positive values slice forward (left-to-right), negative values slice backward (right-to-left).
-     * @default 1
-     */
-    step?: number;
-    /**
-     * The index to start slicing from (inclusive).
-     * Supports negative values to start relative to the end of the array.
-     * @default 0
-     */
-    offsetStart?: number;
-    /**
-     * The index to end slicing at (exclusive).
-     * Supports negative values to end relative to the end of the array.
-     * Defaults to the end of the array (if step > 0) or -1 (if step < 0).
-     */
-    offsetEnd?: number;
-    /**
-     * Caps the maximum number of items gathered in the sliced result list.
-     * If specified, the slicing process stops once this limit is reached.
-     */
-    maxItemsGathered?: number;
-    /**
-     * If true, returns null when the starting offset is out of bounds.
-     * If false, throws an error when the starting offset is out of bounds.
-     * @default true
-     */
-    null_on_oob?: boolean;
-}
-export declare function stepSliceList<T>(arr: ArrayLike<T>, { step, offsetStart, offsetEnd, maxItemsGathered, null_on_oob }?: StepSliceListOptions): T[] | null;
-/**
- * Options configuration for the `joinList` utility.
- */
-export interface JoinListOptions {
-    /**
-     * If true, nullish elements (null and undefined) are completely ignored during joining.
-     * If false (default), nullish elements are serialized as empty strings or custom `nullValue`.
-     * @default false
-     */
-    ignoreNulls?: boolean;
-    /**
-     * Custom string representation for nullish values.
-     * Only applied if `ignoreNulls` is false.
-     * @default ""
-     */
-    nullValue?: string;
-    /**
-     * Optional prefix string prepended to the final joined result.
-     * @default ""
-     */
-    prefix?: string;
-    /**
-     * Optional suffix string appended to the final joined result.
-     * @default ""
-     */
-    suffix?: string;
-    /**
-     * Maximum number of list elements to join.
-     * If specified, elements beyond this limit are omitted and `truncationMarker` is appended.
-     */
-    limit?: number;
-    /**
-     * Custom placeholder string appended to the joined string when limit truncation occurs.
-     * Only applied if `limit` is specified and the list length exceeds it.
-     * @default "..."
-     */
-    truncationMarker?: string;
-    /**
-     * Callback function used to format each individual non-null element to a custom string representation.
-     */
-    valueFormatter?: (val: any, index: number) => string;
-}
-/**
- * Joins the elements of an array-like structure into a string using a separator.
- * Excludes nullish checks and formats nested arrays cleanly.
- */
-export declare function joinList(arr: ArrayLike<any>, separator?: string, { ignoreNulls, nullValue, prefix, suffix, limit, truncationMarker, valueFormatter }?: JoinListOptions): string;
-export interface FillSeqBaseOptions {
-    /**
-     * Type coercion helper applied to each generated value before writing.
-     *
-     * @param v The newly generated candidate value.
-     * @returns The coerced value to write to the array.
-     */
-    coerce?: (v: any) => any;
-    /**
-     * Conditional predicate determining if a value should be replaced at a given index.
-     *
-     * @param v The original/current value at the target index.
-     * @param index The absolute index of the current element.
-     * @param array The entire target array.
-     * @returns True if the candidate value should overwrite the original value, false otherwise.
-     */
-    condition?: (v: any, index: number, array: any[]) => boolean;
-    /**
-     * If true, iterates and populates in reverse (from startIndex down to endIndex).
-     * @default false
-     */
-    reverse?: boolean;
-    /**
-     * The index at which array iteration and writing begins.
-     * @default reverse ? length - 1 : 0
-     */
-    startIndex?: number;
-    /**
-     * The exclusive boundary index at which iteration and writing stops.
-     * @default reverse ? -1 : length
-     */
-    endIndex?: number;
-}
-export interface CumulativeStepContext {
-    /** The accumulated value returned by the step function from the previous stepped index. */
-    prev: any;
-    /** The relative iteration counter of the stepping process (starts at 1). */
-    index: number;
-    /** The original value at the current index in the target array. */
-    originalValue: any;
-    /** The absolute index of the current element in the parent array. */
-    absoluteIndex: number;
-    /** The entire target array being populated/modified. */
-    targetArray: any;
-}
-export interface IndependentStepContext {
-    /** The relative iteration counter of the generation process (starts at 0). */
-    index: number;
-    /** The static starting value passed to the sequence generator. */
-    initialValue: any;
-    /** The original value at the current index in the target array. */
-    originalValue: any;
-    /** The absolute index of the current element in the parent array. */
-    absoluteIndex: number;
-    /** The entire target array being populated/modified. */
-    targetArray: any;
-}
-export type FillSeqOptions = FillSeqBaseOptions & ({
-    mode: "constant";
-    step?: never;
-} | {
-    mode?: "cumulative";
-    step?: number | ((context: CumulativeStepContext) => any);
-} | {
-    mode: "independent";
-    step?: number | ((context: IndependentStepContext) => any);
-});
-export declare function fillSequence(targetArray: any, initialValue: any, options?: FillSeqOptions): void;
-/**
- * Computes the median of a numeric array, filtering out non-numeric and NaN values.
- * Returns null if no valid numbers remain.
- */
-export declare function computeMedian(values: ArrayLike<any>): number | null;
-/**
- * Computes the quantile of a numeric array using linear interpolation, filtering out non-numeric and NaN values.
- * q must be in [0, 1]. Returns null if no valid numbers remain or q is out of bounds.
- */
-export declare function computeQuantile(values: ArrayLike<any>, q: number): number | null;
-/**
- * Computes the mode(s) of an array, filtering out null/undefined values.
- * Returns an array of the most frequent values, sorted, or null if empty/no mode.
- */
-export declare function computeMode(values: ArrayLike<any>): any[] | null;