Merge branch 'main' into add-test-cases

cuppachino · Sep 6, 2023 · 026fe13 · 026fe13
2 parents d6fc3a4 + 0d29bcd
commit 026fe13
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 41 deletions.
diff --git a/.changeset/neat-brooms-switch.md b/.changeset/neat-brooms-switch.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,23 @@
 # @cuppachino/proxy-fn
 
+## 1.0.2
+
+### Patch Changes
+
+- 67d3357: Update README.md
+
+## 1.0.1
+
+### Patch Changes
+
+- 6f0b02d: Update README.md
+
+## 1.0.0
+
+### Major Changes
+
+- 6f7692d: add tests and pass all cases
+
 ## 0.0.2
 
 ### Patch Changes

diff --git a/README.md b/README.md
@@ -36,16 +36,10 @@ const add = (a: number, b: number) => a + b
  * (a: number, b: number, ...args: number[]) => number
  *
  * ProxyFn<
- *   // From
+ *   // NewArgs
  *   [a: number, b: number, ...args: number[]],
- *   // ExpectedArgs
- *   [a: number, b: number],
- *   // ActualArgs
- *   [number, number]
- *   // To
- *   number,
- *   // Original function
- *   (a: number, b: number) => number
+ *   // NewReturnType
+ *   number
  * >
  * ```
  */
@@ -66,16 +60,10 @@ addMany(1, 2, 3, 4) // number
  * (a: number, b: number) => Promise<readonly [number, string]>
  *
  * ProxyFn<
- *   // From
- *   [a: number, b: number],
- *   // ExpectedArgs
+ *   // NewArgs
  *   [a: number, b: number],
- *   // ActualArgs
- *   MaybePromise<[a: number, b: number, ...any[]]>,
- *   // To
- *   Promise<readonly [number, string]>,
- *   // Original function
- *   (a: number, b: number) => number
+ *   // NewReturnType
+ *   Promise<readonly [number, string]>
  * >
  * ```
  */
@@ -94,19 +82,15 @@ infersPromises(4, 8) // Promise<[sum: number, msg: string]>
 ```ts
 /**
  * ```ts
- * () => Promise<[sum: number, msg: string]>
+ * (() => Promise<[sum: number, msg: string]>) & { name: string }
  *
  * ProxyFn<
- *   // From
+ *   // NewArgs
  *   [],
- *   // ExpectedArgs
- *   [a: number, b: number],
- *   // ActualArgs
- *   Promise<[number, number]>,
- *   // To
- *   [sum: number, msg: string],
- *   // Original function
- *   ((a: number, b: number) => number) & { name: string; }
+ *   // NewReturnType
+ *   Promise<[sum: number, msg: string]>,
+ *   // Properties
+ *   { name: string }
  * >
  * ```
  */

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cuppachino/proxy-fn",
-  "version": "0.0.2",
+  "version": "1.0.2",
   "description": "",
   "type": "module",
   "main": "dist/cjs/index.js",

diff --git a/src/modules/index.ts b/src/modules/index.ts
@@ -1 +1 @@
-export * from './proxy-fn.js'
+export * from './proxy-fn.js'
diff --git a/src/types/is-empty.ts b/src/types/is-empty.ts
@@ -1,3 +1,3 @@
-import type { IsNever } from "./is-never.js";
+import type { IsNever } from './is-never.js'
 
-export type IsEmpty<T> = IsNever<keyof NonNullable<T>>
+export type IsEmpty<T> = IsNever<keyof NonNullable<T>>
diff --git a/src/types/is-never.ts b/src/types/is-never.ts
@@ -1 +1 @@
-export type IsNever<T> = [T] extends [never] ? true : false;
+export type IsNever<T> = [T] extends [never] ? true : false
diff --git a/src/utils/is-promise.ts b/src/utils/is-promise.ts
@@ -2,8 +2,6 @@
  * Returns true if the given thing is a promise.
  * @param anything The thing to check. Might be undefined.
  */
-export const isPromise = <T>(
-  anything: T | Promise<T> | undefined
-): anything is Promise<T> => {
+export const isPromise = <T>(anything: T | Promise<T> | undefined): anything is Promise<T> => {
   return !!anything && anything instanceof Promise
 }