Add docs

jeffdgr8 · Jan 23, 2024 · c75ba7b · c75ba7b
1 parent 593a6a2
commit c75ba7b
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 0 deletions.
diff --git a/couchbase-lite-ee-ktx/README.md b/couchbase-lite-ee-ktx/README.md
@@ -76,6 +76,26 @@ val document = MutableDocument {
 database.save(document)
 ```
 
+##### Collection creation functions
+
+You can create a `MutableArray` or `MutableDictionary` using idiomatic `vararg` functions:
+
+```kotlin
+mutableArrayOf("hello", 42, true)
+mutableDictOf("key1" to "value1", "key2" to 2, "key3" to null)
+```
+
+The similar `mutableDocOf` function allows nesting dictionary types, unlike the `MutableDocument` DSL:
+
+```kotlin
+mutableDocOf(
+    "string" to "hello",
+    "number" to 42,
+    "array" to mutableArrayOf(1, 2, 3),
+    "dict" to mutableDictOf("key" to "value")
+)
+```
+
 #### Flow support
 
 Supplementing the `Flow` APIs from [Couchbase Lite Android KTX](

diff --git a/couchbase-lite-ktx/README.md b/couchbase-lite-ktx/README.md
@@ -76,6 +76,26 @@ val document = MutableDocument {
 database.save(document)
 ```
 
+##### Collection creation functions
+
+You can create a `MutableArray` or `MutableDictionary` using idiomatic `vararg` functions:
+
+```kotlin
+mutableArrayOf("hello", 42, true)
+mutableDictOf("key1" to "value1", "key2" to 2, "key3" to null)
+```
+
+The similar `mutableDocOf` function allows nesting dictionary types, unlike the `MutableDocument` DSL:
+
+```kotlin
+mutableDocOf(
+    "string" to "hello",
+    "number" to 42,
+    "array" to mutableArrayOf(1, 2, 3),
+    "dict" to mutableDictOf("key" to "value")
+)
+```
+
 #### Flow support
 
 Supplementing the `Flow` APIs from [Couchbase Lite Android KTX](

diff --git a/docs/ktx.md b/docs/ktx.md
@@ -86,6 +86,26 @@ val document = MutableDocument {
 database.save(document)
 ```
 
+#### Collection creation functions
+
+You can create a `MutableArray` or `MutableDictionary` using idiomatic `vararg` functions:
+
+```kotlin
+mutableArrayOf("hello", 42, true)
+mutableDictOf("key1" to "value1", "key2" to 2, "key3" to null)
+```
+
+The similar `mutableDocOf` function allows nesting dictionary types, unlike the `MutableDocument` DSL:
+
+```kotlin
+mutableDocOf(
+    "string" to "hello",
+    "number" to 42,
+    "array" to mutableArrayOf(1, 2, 3),
+    "dict" to mutableDictOf("key" to "value")
+)
+```
+
 ### Flow support
 
 Supplementing the `Flow` APIs from [Couchbase Lite Android KTX](