add typedoc

README.md

@@ -25,6 +25,15 @@
 
 Skeet Utils Plugin for Utitilies.
 
+This plugin is a collection of utilities for basic operations.
+
+- Encryption
+- String
+- Number
+- Time
+- Http
+- Notification
+
 # Installation
 
 ```bash
@@ -39,6 +48,8 @@ $ yarn add @skeet-framework/utils
 
 # Skeet Utils Docs
 
+More information can be found in the following documents.
+
 - [Skeet Utils TypeDoc](https://elsoul.github.io/skeet-utils/)
 
 ## Skeet Framework Document

dist/cjs/lib/crypto/base64.d.ts

@@ -1,2 +1,24 @@
+/**
+ * Encodes a payload to base64.
+ *
+ * @param payload - The data to be encoded.
+ * @returns The base64-encoded payload.
+ *
+ * @example
+ * const data = 'Hello, world!';
+ * const encodedData = encodeBase64(data);
+ * console.log(encodedData); // Base64-encoded data
+ */
 export declare const encodeBase64: (payload: string) => string;
+/**
+ * Decodes a base64-encoded payload to a string.
+ *
+ * @param payload - The base64-encoded data to be decoded.
+ * @returns The decoded payload as a UTF-8 string.
+ *
+ * @example
+ * const encodedData = 'SGVsbG8sIHdvcmxkIQ=='; // Base64-encoded data
+ * const decodedData = decodeBase64(encodedData);
+ * console.log(decodedData); // Decoded data: "Hello, world!"
+ */
 export declare const decodeBase64: (payload: string) => string;

dist/cjs/lib/crypto/crypto.d.ts

@@ -1,3 +1,3 @@
-export declare const encrypt: (data: string, iv: string, password: string, salt: string) => string;
-export declare const decrypt: (data: string, iv: string, password: string, salt: string) => string;
-export declare const generateIv: () => string;
+export declare const algorithm = "aes-256-cbc";
+export declare const inputEncoding = "utf8";
+export declare const outputEncoding = "base64";

dist/cjs/lib/crypto/decrypt.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @module crypto
+ * @preferred
+ */
+/**
+ * Decrypts data using the given parameters.
+ *
+ * @param encryptedData - The encrypted data.
+ * @param iv - The initialization vector.
+ * @param password - The password for decryption.
+ * @param salt - The salt for key derivation.
+ * @returns The decrypted data.
+ *
+ * @example
+ * const encrypted = 'EncryptedDataHere'; // Encrypted data obtained from the encryption process
+ * const iv = '1234567890123456'; // Initialization vector used in the encryption process
+ * const password = 'MySecretPassword'; // Password used in the encryption process
+ * const salt = 'MySalt'; // Salt used in the encryption process
+ * const decrypted = decrypt(encrypted, iv, password, salt);
+ * console.log(decrypted);
+ */
+export declare const decrypt: (encryptedData: string, iv: string, password: string, salt: string) => string;

dist/cjs/lib/crypto/encrypt.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @module crypto
+ * @preferred
+ */
+/**
+ * Encrypts data using the given parameters.
+ *
+ * @param data - The data to be encrypted.
+ * @param iv - The initialization vector.
+ * @param password - The password for encryption.
+ * @param salt - The salt for key derivation.
+ * @returns The encrypted data.
+ *
+ * @example
+ * const data = 'Sensitive information';
+ * const iv = '1234567890123456'; // 16 characters
+ * const password = 'MySecretPassword';
+ * const salt = 'MySalt';
+ * const encrypted = encrypt(data, iv, password, salt);
+ * console.log(encrypted);
+ */
+export declare const encrypt: (data: string, iv: string, password: string, salt: string) => string;

dist/cjs/lib/crypto/genRandomSalt.d.ts

@@ -1 +1,11 @@
+/**
+ * Generates a random salt for key derivation.
+ *
+ * @param bytes - The number of bytes for the generated salt. Default is 16 bytes.
+ * @returns The generated salt as a hexadecimal string.
+ *
+ * @example
+ * const salt = generateRandomSalt();
+ * console.log(salt); // Random hexadecimal salt
+ */
 export declare function generateRandomSalt(bytes?: number): string;

dist/cjs/lib/crypto/generateIv.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generates a random initialization vector (IV) for encryption.
+ *
+ * @returns The generated initialization vector as a base64-encoded string.
+ *
+ * @example
+ * const iv = generateIv();
+ * console.log(iv); // Random base64-encoded initialization vector
+ */
+export declare const generateIv: () => string;

dist/cjs/lib/crypto/index.d.ts

@@ -1,4 +1,6 @@
 export * from './base64';
-export * from './crypto';
 export * from './placeholder';
 export * from './genRandomSalt';
+export * from './generateIv';
+export * from './encrypt';
+export * from './decrypt';