@spscommerce/utils 5.10.2 → 5.10.5-ie

package/lib/number/constrain.d.ts

@@ -1,7 +0,0 @@
-/**
- * Constrains a number to the given range. If the number is below the
- * low end of the range, the low end will be returned. If the number is
- * above the top end of the range, the top end will be returned. Otherwise
- * the number itself will be returned.
- */
-export declare function constrain(n: number, range: [number, number]): number;

package/lib/number/decimal-round.d.ts

@@ -1,7 +0,0 @@
-/**
- * Progressively rounds `num` to `decimalPlaces` places. This differs from other
- * rounding methods out there such as lodash's, which are not progressive. For example,
- * `(0.149).toFixed(1)` and lodash `_.round(0.149, 1)` both return `0.1`, but this
- * function rounds `0.149` to `0.15` and then `0.15` to `0.2` and returns `0.2`.
- */
-export declare function decimalRound(num: number, decimalPlaces?: number): number;

package/lib/number/decimal-round.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/number/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./constrain";
-export * from "./decimal-round";
-export * from "./to-file-size-string";

package/lib/number/to-file-size-string.d.ts

@@ -1,5 +0,0 @@
-/**
- * Converts a file size in bytes to a human-friendly string. For example,
- * `toFileSizeString(2048)` will return `"2.00KB"`.
- */
-export declare function toFileSizeString(n: number, precision?: number): string;

package/lib/object/copy-property.d.ts

@@ -1,6 +0,0 @@
-/**
- * Copy a property from one object to another using its property descriptor.
- * In other words, if it's a getter/setter on `sourceObject` it'll be the same
- * getter/setter on `destObject`. If it's just a value it'll be just a value.
- */
-export declare function copyProperty(propName: PropertyKey, sourceObject: any, destObject: any): void;

package/lib/object/copy-property.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/crumble-path.d.ts

@@ -1,6 +0,0 @@
-/**
- * Converts a path to crumbs.
- *  For example:
- *  "a.b[0].c" -> ["a", "b", "0", "c"]
- */
-export declare function crumblePath(path: string | PropertyKey | PropertyKey[]): PropertyKey[];

package/lib/object/crumble-path.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/deep-freeze.d.ts

@@ -1 +0,0 @@
-export declare function deepFreeze(obj: any): void;

package/lib/object/deep-freeze.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/diff.d.ts

@@ -1,12 +0,0 @@
-export declare enum DiffChange {
-    ADDITION = 0,
-    DELETION = 1,
-    ALTERATION = 2
-}
-export interface DiffEntry {
-    type: DiffChange;
-    key: PropertyKey;
-    parentPath: PropertyKey[];
-    objects: [Record<PropertyKey, unknown>, Record<PropertyKey, unknown>];
-}
-export declare function diff(o1: Record<PropertyKey, unknown>, o2: Record<PropertyKey, unknown>, parentPath?: PropertyKey[]): DiffEntry[];

package/lib/object/diff.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/for-each-entry-deep.d.ts

@@ -1,4 +0,0 @@
-/**
- * Recursively navigate a nested object & call `fn` for each key/value pair
- */
-export declare function forEachEntryDeep(object: any, fn: (key: string, value: any, object: any) => any): any;

package/lib/object/for-each-entry-deep.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/for-each-nested-object.d.ts

@@ -1,4 +0,0 @@
-/**
- * Recursively navigate a nested object & call `fn` for each subobject
- */
-export declare function forEachNestedObject(object: any, fn: (path: PropertyKey[], object: any) => any, path?: PropertyKey[]): any;

package/lib/object/for-each-nested-object.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/get-path.d.ts

@@ -1,5 +0,0 @@
-/**
- * Get the value at `path` starting from `object`.
- * Allows optional chaining, e.g. `get(obj, 'a.b?.c')`
- */
-export declare function getPath<T>(object: any, path: string | PropertyKey | PropertyKey[], defaultValue?: T, allOptional?: boolean): T;

package/lib/object/get-path.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/index.d.ts

@@ -1,13 +0,0 @@
-export * from "./crumble-path";
-export * from "./copy-property";
-export * from "./deep-freeze";
-export * from "./diff";
-export * from "./for-each-entry-deep";
-export * from "./for-each-nested-object";
-export * from "./get-path";
-export * from "./omit";
-export * from "./set-path";
-export * from "./traverse-path";
-export * from "./merge-deep";
-export * from "./merge-properties-deep";
-export * from "./values";

package/lib/object/merge-deep.d.ts

@@ -1,4 +0,0 @@
-/**
- * Recursive merge of any number of objects
- */
-export declare function mergeDeep(...objectsToMerge: any[]): any;

package/lib/object/merge-deep.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/merge-properties-deep.d.ts

@@ -1,4 +0,0 @@
-/**
- * Recursive merge of any number of objects using `copyProperty()` rather than assignment
- */
-export declare function mergePropertiesDeep(...objectsToMerge: any[]): any;

package/lib/object/merge-properties-deep.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/omit.d.ts

@@ -1 +0,0 @@
-export declare function omit(obj: any, ...keys: PropertyKey[]): {};

package/lib/object/omit.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/set-path.d.ts

@@ -1,2 +0,0 @@
-/** Set the value at `path` on `object`. */
-export declare function setPath(object: any, path: PropertyKey | PropertyKey[], newValue: any): void;

package/lib/object/set-path.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/object/traverse-path.d.ts

@@ -1,2 +0,0 @@
-/** Generator for iterating down a path on an object. */
-export declare function traversePath(object: any, path: any): Generator<any, void, unknown>;

package/lib/object/values.d.ts

@@ -1,2 +0,0 @@
-/** Returns the values of an object. */
-export declare function values(object: any): any[];

package/lib/object/values.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/string/code.template-tag.d.ts

@@ -1,2 +0,0 @@
-/** Template tag function for making strings containing code blocks easier to deal with. */
-export declare function code(strings: TemplateStringsArray, ...interpolations: unknown[]): string;

package/lib/string/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./code.template-tag";
-export * from "./parse-file-size";
-export * from "./template";

package/lib/string/parse-file-size.d.ts

@@ -1,5 +0,0 @@
-/**
- * Parses a string as a file size and returns the size in bytes. For example,
- * `parseFileSize("2KB")` will return `2048`.
- */
-export declare function parseFileSize(fileSize: string): number;

package/lib/string/template.d.ts

@@ -1,15 +0,0 @@
-declare type TemplateFn = (data: any) => string;
-/**
- *  Every string templating thing out there whether lodash, doT, handlebars, etc
- *  is extremely complicated to cover a variety of use cases. This just has two
- *  very simple features and great caution should be exercised in making it any more
- *  complex than that. A value can be interpolated like so:
- *  `<%= foo.bar %>`
- *  And a basic "if" conditional can be used like so:
- *  `<%? a?.b?.c %>This part will only appear if a.b.c is truthy!</%>`
- *  You can put interpolations inside a conditional, as you'd expect. That's it.
- */
-export declare function template(string: string): TemplateFn;
-export declare function isTemplate(x: any): x is string;
-export declare function isTemplateFn(x: any): x is TemplateFn;
-export {};

package/lib/string/template.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/typings.d.ts

@@ -1 +0,0 @@
-export declare type Eventually<T> = T | Promise<T>;