promisify-ts 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Egor Kushnarev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# promisify-ts
+Compile-time functional type for convert common interfaces to it's promisified variant
+
+## when is this useful?
+It is good tool for converting your sync API interfaces that is shared through async transport like Electron IPC
+
+## install
+`npm install promisify-ts`
+
+## possibilities
+
+### promisify methods
+```ts
+import { Promisify } from "promisify-ts";
+
+interface MyInterface {
+    transformToString(value: number): string;
+    getPromise(): Promise<string>;
+    getDoublePromise(): Promise<Promise<string>>
+}
+
+type PromisifiedInterface = Promisify<MyInterface>
+```
+
+`PromisifiedInterface` will be transformed as
+
+```ts
+type PromisifiedInterface = {
+    transformToString(value: number): Promise<string>; // (number) => string -> (number) => Promise<string>
+    getPromise(): Promise<string>;                     // () => Promise<string> -> () => Promise<string>
+    getDoublePromise(): Promise<string>                // () => Promise<Promise<string>> -> () => Promise<string>
+}
+```
+
+### optional decay properties
+By default, everything except methods is removed, so
+
+```ts
+import { Promisify } from "promisify-ts";
+
+interface MyInterface {
+    readonly id: number;
+    transformToString(value: number): string;
+}
+
+type PromisifiedInterface = Promisify<MyInterface>
+```
+
+will be transformed as
+
+```ts
+type PromisifiedInterface = {
+    readonly id: never;                                // number -> never
+    transformToString(value: number): Promise<string>; // (number) => string -> (number) => Promise<string>
+}
+```
+
+but `Promisify` has second optional boolean parameter `RemoveProperties`, `true` by default that tells function remove or not properties
+
+```ts
+type PromisifiedInterface = Promisify<MyInterface, false>
+```
+
+makes
+
+```ts
+type PromisifiedInterface = {
+    readonly id: number;                               // number -> number
+    transformToString(value: number): Promise<string>; // (number) => string -> (number) => Promise<string>
+}
+```
+
+This may be useful if further conversions of the interface type are expected.
+
+### works good with generic methods
+```ts
+import { Promisify } from "promisify-ts";
+
+interface MyInterface<U> {
+    transformStringToU(value: string): U;
+    transformUToString(value: U): string;
+}
+
+type PromisifiedInterface = Promisify<MyInterface<number>>
+```
+
+will tranform into
+
+```ts
+type PromisifiedInterface = {
+    transformStringToU(value: string): Promise<number>; // (string) => U -> (string) => Promise<U>
+    transformUToString(value: number): Promise<string>; // (U) => string -> (number) => Promise<string>
+}
+```
+
+### also promisifies returned functions
+```ts
+import { Promisify } from "promisify-ts";
+
+interface MyInterface {
+    getCallback(): () => string;
+}
+
+type PromisifiedInterface = Promisify<MyInterface>
+```
+
+makes
+
+```ts
+type PromisifiedInterface = {
+    getCallback(): Promise<() => Promise<string>>; // () => () => string -> () => Promise<() => Promise<string>>
+}
+```
+
+## thanks
+Special thanks for [@Nipheris](https://github.com/Nipheris) who once helped in this brainstorming

package/index.ts

@@ -0,0 +1,20 @@
+// @ts-nocheck
+type Method<P extends unknown[], R extends unknown = unknown> = (...args: P) => R;
+type PromisifyedMethod<P extends unknown[], R extends unknown = unknown> = Method<P, Promise<R>>;
+
+type DecayPromiseAndMethod<R> =
+	R extends Promise<infer T> ? DecayPromiseAndMethod<T> :
+	R extends Method<infer P>  ? PromisifyMethod<R> :
+	R;
+
+type PromisifyMethod<M> =
+	M extends <R>(...args: infer P) => Promise<R> ? <R>(...args: P) => Promise<DecayPromiseAndMethod<R>> :
+	M extends <R>(...args: infer P) => R          ? <R>(...args: P) => Promise<DecayPromiseAndMethod<R>> :
+	M extends Method<infer P, infer R>            ? PromisifyedMethod<P, DecayPromiseAndMethod<R>> :
+	never;
+
+export type Promisify<T, RemoveProperties = true> = {
+	[K in keyof T]:
+		T[K] extends Method<infer P> ? PromisifyMethod<T[K]> :
+		RemoveProperties extends false ? T[K] : never;
+};

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "promisify-ts",
+  "version": "1.0.0",
+  "description": "Compile-time functional type for convert common interfaces to it's promisified variant",
+  "homepage": "https://github.com/origin-yaropolk/promisify-ts",
+  "keywords": ["promisify", "promisified", "inteface", "async", "promisify-ts"],
+  "author": "Egor Kushnarev",
+  "license": "MIT",
+  "packageManager": "pnpm@10.10.0",
+  "exports": {
+    ".": {
+        "default": "./index.ts"
+      }
+  }
+}