@ambassify/language-object - npm Package Compare versions

Comparing version 0.1.6 to 0.1.7

package.json

 {
   "name": "@ambassify/language-object",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Detection and conversion library for language objects.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -100,1 +100,39 @@ # language-object
 ```
+
+### translate
+
+Takes in an object an selects only the language key that you would like to have selected.
+
+```js
+cast(sourceObject, [selectLanguage], [availableLanguages])
+```
+
+**Example:**
+
+```js
+const cast = require('@ambassify/language-object/translate');
+
+const obj = {
+    hi_nl: 'hallo',
+    hi_en: 'hello',
+    nested: {
+        regular: 'key',
+        value_nl: 'in dutch',
+        value_en: 'in english'
+    }
+};
+
+translate(obj, 'en', ['en','nl']);
+```
+
+Returns
+
+```js
+{
+    hi: 'hello',
+    nested: {
+        regular: 'key',
+        value: 'in english'
+    }
+}
+```

No alert changes

Improved metrics

Total package byte prevSize

17773

increased by3.34%

Number of lines in readme file

138

increased by38%

No dependency changes