Skip to content

Commit 712d666

Browse files
committed
docs: api docs
1 parent b8fc138 commit 712d666

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/database/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,9 @@ export type UseListOptions = UseDatabaseRefOptions
160160
export type UseObjectOptions = UseDatabaseRefOptions
161161

162162
/**
163-
* Creates a reactive variable connected to the database.
163+
* Creates a reactive variable connected to the database as an array. Each element in the array will contain an `id`
164+
* property. Note that if you override the `serialize` option, it should **also set an `id` property** in order for this
165+
* to work.
164166
*
165167
* @param reference - Reference or query to the database
166168
* @param options - optional options

0 commit comments

Comments
 (0)