Add *.d.ts files

diff --git a/README.md b/README.md
index 310b7b40a7ef967250d33b2e9370a5a2fbef2b8d..bc2d0f87d56b44ef0cdef5a2ead5577339d15b53 100644 (file)
--- a/README.md
+++ b/README.md
@@ -85,3 +85,13 @@ You can also import the function dynamically (useful for lazy-loading or testing
 ```javascript
 const { decrypt } = await import('https://cdn.statically.io/gh/ardislu/static-encrypt/master/decrypt.js');
 ```
+
+### TypeScript
+
+`*.d.ts` files are generated from the [JSDoc](https://jsdoc.app/) comments using `tsc`:
+
+```
+tsc --declaration --emitDeclarationOnly --allowJs .\decrypt.js .\encrypt.js
+```
+
+These `*.d.ts` files allow `encrypt` and `decrypt` to be imported in `.ts` files with typing.

diff --git a/decrypt.d.ts b/decrypt.d.ts
new file mode 100644 (file)
index 0000000..1ca1795
--- /dev/null
+++ b/decrypt.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Decrypt an encrypted string.
+ * @param {string} content - The ciphertext to decrypt.
+ * @param {string} password - The password used to encrypt the string.
+ * @returns {Promise<string>} A promise that resolves to the plaintext.
+ */
+export function decrypt(content: string, password: string): Promise<string>;

diff --git a/encrypt.d.ts b/encrypt.d.ts
new file mode 100644 (file)
index 0000000..158def8
--- /dev/null
+++ b/encrypt.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Encrypt a string.
+ * @param {string} plaintext - The string to encrypt.
+ * @param {string} password - The password used to encrypt the string.
+ * @returns {Promise<string>} A promise that resolves to the ciphertext.
+ */
+export function encrypt(plaintext: string, password: string): Promise<string>;