docs: add parameter types

slang-i18n · Mar 2, 2024 · 3b54c35 · 3b54c35
1 parent 4ce2617
commit 3b54c35
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/slang/CHANGELOG.md b/slang/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 3.30.0
+
+- feat: add parameter types (e.g. `Hello {name: String}, you are {age: int} years old`); is `Object` by default @Tienisto
+- fix: handle nested interfaces (#191) @Tienisto
+- refactor: move code to src folder @Tienisto
+
 ## 3.29.0
 
 - feat: `dart run slang analyze` supports csv files (#185) @nikaera

diff --git a/slang/README.md b/slang/README.md
@@ -63,6 +63,7 @@ dart run slang migrate arb src.arb dest.json # migrate arb to json
   - [Linked Translations](#-linked-translations)
   - [Pluralization](#-pluralization)
   - [Custom Contexts / Enums](#-custom-contexts--enums)
+  - [Typed Parameters](#-typed-parameters)
   - [Interfaces](#-interfaces)
   - [Modifiers](#-modifiers)
   - [Locale Enum](#-locale-enum)
@@ -883,6 +884,18 @@ contexts:
     generate_enum: false # turn off enum generation
 ```
 
+### ➤ Typed Parameters
+
+Parameters are typed as `Object` by default. This is handy because it offers maximum flexibility.
+
+You can specify the type using the `name: type` syntax to increase type safety.
+
+```json
+{
+  "greet": "Hello {name: String}, you are {age: int} years old"
+}
+```
+
 ### ➤ Interfaces
 
 Often, multiple objects have the same attributes. You can create a common super class for that.