@vinicunca/perkakas 0.5.4 → 1.0.1

package/dist/has-sub-object.d.ts

@@ -0,0 +1,55 @@
+import { Simplify } from 'type-fest';
+import { B as Branded } from './types-BMu1PIvo.js';
+
+declare const HAS_SUB_OBJECT_BRAND: unique symbol;
+type HasSubObjectGuard<T, S> = Simplify<Branded<S & T, typeof HAS_SUB_OBJECT_BRAND>>;
+type HasSubObjectObjectValue<A, B> = Partial<{
+    [Key in keyof A & keyof B]: A[Key] & B[Key] extends never ? B[Key] : A[Key] | B[Key] extends object ? HasSubObjectObjectValue<A[Key], B[Key]> : A[Key] & B[Key] extends object ? B[Key] : A[Key];
+}> & {
+    [Key in Exclude<keyof A, keyof B> | Exclude<keyof B, keyof A>]: Key extends keyof B ? B[Key] : never;
+};
+type HasSubObjectData<Data, SubObject, RData = Required<Data>, RSubObject = Required<SubObject>> = Partial<{
+    [Key in keyof RData & keyof RSubObject]: RData[Key] & RSubObject[Key] extends never ? RSubObject[Key] : RData[Key] | RSubObject[Key] extends object ? HasSubObjectObjectValue<RData[Key], RSubObject[Key]> : RData[Key] & RSubObject[Key] extends object ? RSubObject[Key] : RData[Key];
+}> & {
+    [Key in Exclude<keyof SubObject, keyof Data>]: SubObject[Key];
+};
+type HasSubObjectSubObject<SubObject, Data, RSubObject = Required<SubObject>, RData = Required<Data>> = Partial<{
+    [Key in keyof RData & keyof RSubObject]: RData[Key] & RSubObject[Key] extends never ? RData[Key] : RData[Key] | RSubObject[Key] extends object ? HasSubObjectObjectValue<RSubObject[Key], RData[Key]> : RData[Key] & RSubObject[Key] extends object ? RData[Key] : RSubObject[Key];
+}> & {
+    [Key in Exclude<keyof SubObject, keyof Data>]: never;
+};
+/**
+ * Checks if `subObject` is a sub-object of `object`, which means for every
+ * property and value in `subObject`, there's the same property in `object`
+ * with an equal value. Equality is checked with `isDeepEqual`.
+ *
+ * @param data - The object to test.
+ * @param subObject - The sub-object to test against.
+ * @signature
+ *    P.hasSubObject(data, subObject)
+ * @example
+ *    P.hasSubObject({ a: 1, b: 2, c: 3 }, { a: 1, c: 3 }) //=> true
+ *    P.hasSubObject({ a: 1, b: 2, c: 3 }, { b: 4 }) //=> false
+ *    P.hasSubObject({ a: 1, b: 2, c: 3 }, {}) //=> true
+ * @dataFirst
+ * @category Guard
+ */
+declare function hasSubObject<T extends Record<PropertyKey, unknown>, S extends HasSubObjectSubObject<S, T>>(data: T, subObject: S): data is HasSubObjectGuard<T, S>;
+/**
+ * Checks if `subObject` is a sub-object of `object`, which means for every
+ * property and value in `subObject`, there's the same property in `object`
+ * with an equal value. Equality is checked with `isDeepEqual`.
+ *
+ * @param subObject - The sub-object to test against.
+ * @signature
+ *    P.hasSubObject(subObject)(data)
+ * @example
+ *    P.hasSubObject({ a: 1, c: 3 })({ a: 1, b: 2, c: 3 }) //=> true
+ *    P.hasSubObject({ b: 4 })({ a: 1, b: 2, c: 3 }) //=> false
+ *    P.hasSubObject({})({ a: 1, b: 2, c: 3 }) //=> true
+ * @dataLast
+ * @category Guard
+ */
+declare function hasSubObject<S extends Record<PropertyKey, unknown>>(subObject: S): <T extends HasSubObjectData<T, S>>(data: T) => data is HasSubObjectGuard<T, S>;
+
+export { hasSubObject };

package/dist/has-sub-object.js

@@ -0,0 +1 @@
+import{a}from"./chunk-ZSI3ZTMX.js";import"./chunk-YTNT635N.js";import"./chunk-JFXZ246Y.js";import"./chunk-KQGY2DBY.js";export{a as hasSubObject};

package/dist/human-readable-file-size.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkY7RFTHSRcjs = require('./chunk-Y7RFTHSR.cjs');exports.humanReadableFileSize = _chunkY7RFTHSRcjs.a;

package/dist/human-readable-file-size.d.cts

@@ -0,0 +1,14 @@
+/**
+ * Returns human readable file size.
+ * @param bytes the file size in bytes
+ * @param base the base (1000 or 1024)
+ * @signature
+ *  P.humanReadableFileSize(bytes, base)
+ * @example
+ *  P.humanReadableFileSize(1000); // => '1.0 kB'
+ *  P.humanReadableFileSize(2097152, 1024); // => '2.0 Mib'
+ * @category String
+ */
+declare function humanReadableFileSize(bytes: number, base?: 1000 | 1024): string;
+
+export { humanReadableFileSize };

package/dist/human-readable-file-size.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns human readable file size.
+ * @param bytes the file size in bytes
+ * @param base the base (1000 or 1024)
+ * @signature
+ *  P.humanReadableFileSize(bytes, base)
+ * @example
+ *  P.humanReadableFileSize(1000); // => '1.0 kB'
+ *  P.humanReadableFileSize(2097152, 1024); // => '2.0 Mib'
+ * @category String
+ */
+declare function humanReadableFileSize(bytes: number, base?: 1000 | 1024): string;
+
+export { humanReadableFileSize };

package/dist/human-readable-file-size.js

@@ -0,0 +1 @@
+import{a}from"./chunk-4YJCXB4Y.js";export{a as humanReadableFileSize};

package/dist/identity.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkMLLA7SGZcjs = require('./chunk-MLLA7SGZ.cjs');exports.identity = _chunkMLLA7SGZcjs.a;

package/dist/identity.d.cts

@@ -0,0 +1,20 @@
+/**
+ * A function that returns the first argument passed to it.
+ *
+ * Notice that this is a dataLast impl where the function needs to be invoked
+ * to get the "do nothing" function.
+ *
+ * See also:
+ * `doNothing` - A function that doesn't return anything.
+ * `constant` - A function that ignores the input arguments and returns the same value on every invocation.
+ *
+ * @signature
+ *    P.identity();
+ * @example
+ *    P.map([1,2,3], P.identity()); // => [1,2,3]
+ * @category Function
+ */
+declare const identity: () => typeof identityImplementation;
+declare function identityImplementation<T, Args extends ReadonlyArray<unknown>>(value: T, ..._args: Args): T;
+
+export { identity };

package/dist/identity.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A function that returns the first argument passed to it.
+ *
+ * Notice that this is a dataLast impl where the function needs to be invoked
+ * to get the "do nothing" function.
+ *
+ * See also:
+ * `doNothing` - A function that doesn't return anything.
+ * `constant` - A function that ignores the input arguments and returns the same value on every invocation.
+ *
+ * @signature
+ *    P.identity();
+ * @example
+ *    P.map([1,2,3], P.identity()); // => [1,2,3]
+ * @category Function
+ */
+declare const identity: () => typeof identityImplementation;
+declare function identityImplementation<T, Args extends ReadonlyArray<unknown>>(value: T, ..._args: Args): T;
+
+export { identity };

package/dist/identity.js

@@ -0,0 +1 @@
+import{a}from"./chunk-WUAU3LTQ.js";export{a as identity};

package/dist/index-by.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkHQ2OH3WDcjs = require('./chunk-HQ2OH3WD.cjs');require('./chunk-Y74ER22O.cjs');require('./chunk-7T4AVFYJ.cjs');exports.indexBy = _chunkHQ2OH3WDcjs.a;

package/dist/index-by.d.cts

@@ -0,0 +1,51 @@
+import { b as ExactRecord } from './types-BMu1PIvo.cjs';
+import 'type-fest';
+
+/**
+ * Converts a list of objects into an object indexing the objects by the given
+ * key.
+ *
+ * There are several other functions that could be used to build an object from
+ * an array:
+ * `fromKeys` - Builds an object from an array of *keys* and a mapper for values.
+ * `pullObject` - Builds an object from an array of items with mappers for *both* keys and values.
+ * `fromEntries` - Builds an object from an array of key-value pairs.
+ * `mapToObj` - Builds an object from an array of items and a single mapper for key-value pairs.
+ * Refer to the docs for more details.
+ *
+ * @param data - The array.
+ * @param mapper - The indexing function.
+ * @signature
+ *    P.indexBy(array, fn)
+ * @example
+ *    P.indexBy(['one', 'two', 'three'], x => x.length) // => {3: 'two', 5: 'three'}
+ * @dataFirst
+ * @category Array
+ */
+declare function indexBy<T, K extends PropertyKey>(data: ReadonlyArray<T>, mapper: (item: T, index: number, data: ReadonlyArray<T>) => K): ExactRecord<K, T>;
+/**
+ * Converts a list of objects into an object indexing the objects by the given
+ * key.
+ *
+ * There are several other functions that could be used to build an object from
+ * an array:
+ * `fromKeys` - Builds an object from an array of *keys* and a mapper for values.
+ * `pullObject` - Builds an object from an array of items with mappers for *both* keys and values.
+ * `fromEntries` - Builds an object from an array of key-value pairs.
+ * `mapToObj` - Builds an object from an array of items and a single mapper for key-value pairs.
+ * Refer to the docs for more details.
+ *
+ * @param mapper - The indexing function.
+ * @signature
+ *    P.indexBy(fn)(array)
+ * @example
+ *    P.pipe(
+ *      ['one', 'two', 'three'],
+ *      P.indexBy(x => x.length)
+ *    ) // => {3: 'two', 5: 'three'}
+ * @dataLast
+ * @category Array
+ */
+declare function indexBy<T, K extends PropertyKey>(mapper: (item: T, index: number, data: ReadonlyArray<T>) => K): (data: ReadonlyArray<T>) => ExactRecord<K, T>;
+
+export { indexBy };

package/dist/index-by.d.ts

@@ -0,0 +1,51 @@
+import { b as ExactRecord } from './types-BMu1PIvo.js';
+import 'type-fest';
+
+/**
+ * Converts a list of objects into an object indexing the objects by the given
+ * key.
+ *
+ * There are several other functions that could be used to build an object from
+ * an array:
+ * `fromKeys` - Builds an object from an array of *keys* and a mapper for values.
+ * `pullObject` - Builds an object from an array of items with mappers for *both* keys and values.
+ * `fromEntries` - Builds an object from an array of key-value pairs.
+ * `mapToObj` - Builds an object from an array of items and a single mapper for key-value pairs.
+ * Refer to the docs for more details.
+ *
+ * @param data - The array.
+ * @param mapper - The indexing function.
+ * @signature
+ *    P.indexBy(array, fn)
+ * @example
+ *    P.indexBy(['one', 'two', 'three'], x => x.length) // => {3: 'two', 5: 'three'}
+ * @dataFirst
+ * @category Array
+ */
+declare function indexBy<T, K extends PropertyKey>(data: ReadonlyArray<T>, mapper: (item: T, index: number, data: ReadonlyArray<T>) => K): ExactRecord<K, T>;
+/**
+ * Converts a list of objects into an object indexing the objects by the given
+ * key.
+ *
+ * There are several other functions that could be used to build an object from
+ * an array:
+ * `fromKeys` - Builds an object from an array of *keys* and a mapper for values.
+ * `pullObject` - Builds an object from an array of items with mappers for *both* keys and values.
+ * `fromEntries` - Builds an object from an array of key-value pairs.
+ * `mapToObj` - Builds an object from an array of items and a single mapper for key-value pairs.
+ * Refer to the docs for more details.
+ *
+ * @param mapper - The indexing function.
+ * @signature
+ *    P.indexBy(fn)(array)
+ * @example
+ *    P.pipe(
+ *      ['one', 'two', 'three'],
+ *      P.indexBy(x => x.length)
+ *    ) // => {3: 'two', 5: 'three'}
+ * @dataLast
+ * @category Array
+ */
+declare function indexBy<T, K extends PropertyKey>(mapper: (item: T, index: number, data: ReadonlyArray<T>) => K): (data: ReadonlyArray<T>) => ExactRecord<K, T>;
+
+export { indexBy };

package/dist/index-by.js

@@ -0,0 +1 @@
+import{a}from"./chunk-7R7W43BD.js";import"./chunk-JFXZ246Y.js";import"./chunk-KQGY2DBY.js";export{a as indexBy};