generaltranslation 2.0.49 → 2.0.51

package/README.md

@@ -237,50 +237,6 @@ console.log(results); // [{ translation: "Hola", language: "es" }, { translation
 
 - A promise that resolves to an array of processed results.
 
-### updateRemoteDictionary(updates)
-
-Pushes updates to a remotely cached translation dictionary.
-
-#### Parameters
-
-- `updates` (Update[]): An array of update objects. Each update can be of type `react` or `intl`.
-
-  - **React Update**:
-    - `type`: `'react'`
-    - `data`: An object containing:
-      - `children` (object | string): The React children content to be translated.
-      - `targetLanguage` (string, optional): The target language for the translation.
-      - `metadata` (Record<string, any>): Additional metadata for the translation process.
-
-  - **Intl Update**:
-    - `type`: `'intl'`
-    - `data`: An object containing:
-      - `content` (string): The string content to be translated.
-      - `targetLanguage` (string, optional): The target language for the translation.
-      - `metadata` (Record<string, any>): Additional metadata for the translation process.
-
-#### Returns
-
-- A promise that resolves to a boolean indicating success (`true`) or failure (`false`).
-
-#### Example
-
-```js
-import { updateRemoteDictionary } from 'generaltranslation';
-const updates = [
-    {
-        type: 'react',
-        data: {
-            children: { type: 'div', props: { children: 'Hello, world' } },
-            targetLanguage: 'es',
-            metadata: { id: 'greeting' }
-        }
-    }
-];
-const success = await updateRemoteDictionary(updates);
-console.log(success); // true or false
-```
-
 ## Utility Functions
 
 ### getLanguageDirection

package/dist/index.d.ts

@@ -81,9 +81,11 @@ declare class GT {
     */
     bundleTranslation(requests: Request[]): Promise<Array<any | null>>;
     /**
-    *Pushes updates to a remotely cached translation dictionary.
-    * @param updates - Array of updates with optional targetLanguage.
-    * @returns A promise that resolves to a boolean indicating success or failure.
+    * Pushes updates to a remotely cached translation dictionary.
+    * @param {Update[]} updates - Array of updates with optional targetLanguage.
+    * @param {string} [projectID=this.projectID] - The ID of the project. Defaults to the instance's projectID.
+    * @param {boolean} [replace=false] - Whether to replace the existing dictionary. Defaults to false.
+    * @returns {Promise<string[]>} A promise that resolves to an array of strings indicating the languages which have been updated.
     */
     updateRemoteDictionary(updates: Update[], projectID?: string, replace?: boolean): Promise<string[]>;
 }

package/dist/index.js

@@ -104,9 +104,11 @@ class GT {
         });
     }
     /**
-    *Pushes updates to a remotely cached translation dictionary.
-    * @param updates - Array of updates with optional targetLanguage.
-    * @returns A promise that resolves to a boolean indicating success or failure.
+    * Pushes updates to a remotely cached translation dictionary.
+    * @param {Update[]} updates - Array of updates with optional targetLanguage.
+    * @param {string} [projectID=this.projectID] - The ID of the project. Defaults to the instance's projectID.
+    * @param {boolean} [replace=false] - Whether to replace the existing dictionary. Defaults to false.
+    * @returns {Promise<string[]>} A promise that resolves to an array of strings indicating the languages which have been updated.
     */
     updateRemoteDictionary(updates_1) {
         return __awaiter(this, arguments, void 0, function* (updates, projectID = this.projectID, replace = false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.49",
+  "version": "2.0.51",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",