ayiin 2.0.4 → 2.0.6

package/ayiin/methods/index.d.ts

@@ -0,0 +1,85 @@
+import Crypt from "./crypt";
+import Tools from "./tools";
+import ResponseApi from "./response";
+declare class BaseMethods<C extends Crypt, T extends Tools, R extends ResponseApi> {
+    crypt: C;
+    tools: T;
+    response: R;
+    constructor();
+    /**
+     * Converts an ASCII string to its corresponding Hex representation.
+     * @param {string} asciiString - The ASCII string to be converted.
+     * @returns {string} - The Hex representation of the ASCII string.
+     */
+    asciiToHex: (asciiString: string) => string;
+    /**
+     * Converts a Hex string to its corresponding ASCII representation.
+     * @param {string} hexString - The Hex string to be converted.
+     * @returns {string} - The ASCII representation of the Hex string.
+     */
+    hexToAscii: (hexString: string) => string;
+    /**
+     * Encrypts a plaintext message using the given key.
+     * @param {string} text - The plaintext message to be encrypted.
+     * @param {string} key - The encryption key.
+     * @returns {string} - The encrypted data in Hex format.
+     */
+    encrypt: (text: string, key: string, bufferEncoding?: BufferEncoding) => string;
+    /**
+     * Decrypts an encrypted message using the given key.
+     * @param {string} encrypted - The encrypted data in Hex format.
+     * @param {string} key - The decryption key.
+     * @returns {string} - The decrypted plaintext message.
+     */
+    decrypt: (text: string, key: string, bufferEncoding?: BufferEncoding) => string;
+    md5: (data: string, encoding: BufferEncoding) => string;
+    /**
+     * Format money
+     * @memberof Tools
+     * @param {number} amount
+     * @param {"long" | "short"} [compactDisplay="long"]
+     * @returns string
+     * */
+    formatMoney: (value: number, locales?: Intl.LocalesArgument, options?: Intl.NumberFormatOptions) => string;
+    /**
+     * Generate a random string
+     * @returns {string}
+     * @memberof Tools
+     * @param {number} length
+     * */
+    randomString: (length: number, prefix?: string) => string;
+    successResponse: (caption: string, data: any, code?: number) => {
+        responseCode: number;
+        responseSuccess: boolean;
+        responseMessage: string;
+        responseData: any;
+    };
+    badRequestResponse: (caption: string, title?: string) => {
+        responseCode: number;
+        responseSuccess: boolean;
+        responseMessage: string;
+    };
+    invalidFieldsResponse: (caption: string) => {
+        responseCode: number;
+        responseSuccess: boolean;
+        responseMessage: string;
+    };
+    notFoundResponse: (caption: string) => {
+        responseCode: number;
+        responseSuccess: boolean;
+        responseMessage: string;
+    };
+    unauthorizedResponse: (caption: string) => {
+        responseCode: number;
+        responseSuccess: boolean;
+        responseMessage: string;
+    };
+    internalServerErrorResponse: (caption: string) => {
+        responseCode: number;
+        responseSuccess: boolean;
+        responseMessage: string;
+    };
+}
+declare class Methods extends BaseMethods<Crypt, Tools, ResponseApi> {
+}
+export default Methods;