feat(fn): add noop fn

.changeset/eleven-melons-listen.md

@@ -0,0 +1,5 @@
+---
+"@opentf/utils": minor
+---
+
+Fixed sorting issues.

apps/docs/pages/Colors/_meta.json

@@ -0,0 +1,3 @@
+{
+  "hexToRGB": "hexToRGB"
+}

apps/docs/pages/Function/_meta.json

@@ -0,0 +1,4 @@
+{
+  "noop": "noop",
+  "sleep": "sleep"
+}

apps/docs/pages/Function/noop.mdx

@@ -0,0 +1,24 @@
+import REPL from "../../components/REPL";
+
+> The No Operation function.
+
+## Syntax
+
+```ts
+import { noop } from '@opentf/utils';
+
+noop(): undefined;
+```
+
+## Examples
+
+```ts
+noop(); //=> undefined
+```
+
+## Try
+
+<REPL code={`const { noop } = require('@opentf/utils');
+
+noop();
+`} />

packages/utils/README.md

@@ -43,13 +43,13 @@ bun add @opentf/utils
 ## Usage
 
 ```ts
-import { isNum, range, camelCase, sleep } from '@opentf/utils';
+import { isNum, range, pascalCase, sleep } from '@opentf/utils';
 
 isNum(NaN); //=> false
 
 range(1, 5); //=> [1, 2, 3, 4, 5]
 
-camelCase('i phone'); //=> 'iPhone'
+pascalCase('pascal case'); //=> PascalCase
 
 await sleep(1000); // It suspends the exection for 1 second.
 ```
@@ -63,24 +63,33 @@ await sleep(1000); // It suspends the exection for 1 second.
 - [groupBy](https://js-utils.pages.dev/docs/Array/groupBy)
 - [range](https://js-utils.pages.dev/docs/Array/range)
 - [move](https://js-utils.pages.dev/docs/Array/move)
+- [sort](https://js-utils.pages.dev/docs/Array/sort)
+- [sortBy](https://js-utils.pages.dev/docs/Array/sortBy)
 
 ### Maths
 
 - [percentage](https://js-utils.pages.dev/docs/Maths/percentage)
 - [percentageOf](https://js-utils.pages.dev/docs/Maths/percentageOf)
 
-### Misc
+### Function
 
-- [hexToRGB](https://js-utils.pages.dev/docs/Misc/hexToRGB)
 - [sleep](https://js-utils.pages.dev/docs/Timers/sleep)
+- [noop](https://js-utils.pages.dev/docs/Timers/noop)
+
+### Colors
+
+- [hexToRGB](https://js-utils.pages.dev/docs/Misc/hexToRGB)
 
 ### Object
 
-- [cloneObj](https://js-utils.pages.dev/docs/Object/cloneObj)
+- [clone](https://js-utils.pages.dev/docs/Object/clone)
 - [getInObj](https://js-utils.pages.dev/docs/Object/getInObj)
-- [setInObj](https://js-utils.pages.dev/docs/Object/setInObj)
 - [delInObj](https://js-utils.pages.dev/docs/Object/delInObj)
+- [isEmpty](https://js-utils.pages.dev/docs/Object/isEmpty)
+- [isNil](https://js-utils.pages.dev/docs/Object/isNil)
 - [isShallowEql](https://js-utils.pages.dev/docs/Object/isShallowEql)
+- [setInObj](https://js-utils.pages.dev/docs/Object/setInObj)
+- [size](https://js-utils.pages.dev/docs/Object/size)
 
 ### String
 
@@ -116,6 +125,47 @@ await sleep(1000); // It suspends the exection for 1 second.
 - [isWkRef](https://js-utils.pages.dev/Types/isWkRef)
 - [isWkSet](https://js-utils.pages.dev/Types/isWkSet)
 
+## Benchmarks
+
+Some benchmark outputs are shown here for reference.
+
+> [!IMPORTANT]  
+> Our priorities are reliability and accuracy rather than performance.
+
+```sh
+clone:
+┌───┬──────────────────────────┬─────────┬────────────────────┬────────┬─────────┐
+│   │ Task Name                │ ops/sec │ Average Time (ns)  │ Margin │ Samples │
+├───┼──────────────────────────┼─────────┼────────────────────┼────────┼─────────┤
+│ 0 │ structuredClone (Native) │ 246,358 │ 4059.129038804869  │ ±1.65% │ 24636   │
+│ 1 │ _.cloneDeep (Lodash)     │ 169,432 │ 5902.043319168882  │ ±2.53% │ 16944   │
+│ 2 │ R.clone (ramda)          │ 178,957 │ 5587.9189808343945 │ ±2.26% │ 17897   │
+│ 3 │ R2.clone (remeda)        │ 314,247 │ 3182.204862216371  │ ±1.75% │ 31426   │
+│ 4 │ clone                    │ 399,634 │ 2502.2859323385046 │ ±2.06% │ 39964   │
+└───┴──────────────────────────┴─────────┴────────────────────┴────────┴─────────┘
+*Note: Here the ramda & remeda does not support cloning Map & Set.
+
+sortBy:
+┌───┬────────────────────┬───────────┬───────────────────┬────────┬─────────┐
+│   │ Task Name          │ ops/sec   │ Average Time (ns) │ Margin │ Samples │
+├───┼────────────────────┼───────────┼───────────────────┼────────┼─────────┤
+│ 0 │ _.orderBy (Lodash) │ 1,231,295 │ 812.1529684071648 │ ±3.09% │ 123130  │
+│ 1 │ R.sortWith (Ramda) │ 1,279,200 │ 781.7380570822326 │ ±2.27% │ 127921  │
+│ 2 │ R2.sortBy (Remeda) │ 1,419,707 │ 704.3703291518029 │ ±2.81% │ 141971  │
+│ 3 │ sort (Moderndash)  │ 2,697,568 │ 370.7042634668106 │ ±1.82% │ 269757  │
+│ 4 │ sortBy             │ 2,728,366 │ 366.5196435965459 │ ±2.19% │ 272837  │
+└───┴────────────────────┴───────────┴───────────────────┴────────┴─────────┘
+
+*Note: Here the Moderndash does not support passing object prop as string.
+
+```
+
+### Running benchmarks
+
+```sh
+bun benchmark.js
+```
+
 ## License
 
 Copyright (c) [Thanga Ganapathy](https://github.com/Thanga-Ganapathy) ([MIT License](../../LICENSE)).

packages/utils/__tests__/function/noop.spec.js

@@ -0,0 +1,9 @@
+import { noop } from '../../src';
+
+describe('Misc', () => {
+  test('noop', () => {
+    expect(noop()).toBe(undefined);
+    expect(noop(null)).toBe(undefined);
+    expect(noop(1)).toBe(undefined);
+  });
+});

packages/utils/src/function/noop.ts

@@ -0,0 +1,8 @@
+/**
+ * The No Operation function.
+ *
+ * @example
+ *
+ * noop() //=> undefined
+ */
+export default function noop() {}

packages/utils/src/function/sleep.ts

@@ -0,0 +1,10 @@
+/**
+ * It suspends the execution for the given milliseconds.
+ *
+ * @example
+ *
+ * await sleep(1000) // It sleeps for 1 second
+ */
+export default async function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

packages/utils/src/index.ts

@@ -66,9 +66,12 @@ export { default as isEmpty } from './object/isEmpty';
 export { default as isNil } from './object/isNil';
 export { default as size } from './object/size';
 
-// Misc
-export { default as hexToRGB } from './misc/hexToRGB';
-export { default as sleep } from './misc/sleep';
+// function
+export { default as sleep } from './function/sleep';
+export { default as noop } from './function/noop';
+
+// colors
+export { default as hexToRGB } from './colors/hexToRGB';
 
 // Number
 export { default as clamp } from './number/clamp';