Skip to content

Commit

Permalink
docs(storage): fix readme syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
alimd committed Nov 3, 2022
1 parent 9ad2c48 commit 42820e6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/core/storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ All document ids in array.

Insert/update a document object in the storage.

-*documentObject**: The document object to insert/update contain `_id`.
-*fastInstance**: by default it will make a copy of the document before set.
- **documentObject**: The document object to insert/update contain `_id`.
- **fastInstance**: by default it will make a copy of the document before set.
if you set fastInstance to true, it will set the original document.
This is dangerous but much faster, you should use it only if you know what you are doing.

Expand All @@ -108,8 +108,8 @@ userStorage.set({

Get a document object by id.

-*documentId**: The id of the document object.
-*fastInstance**: by default it will return a copy of the document.
- **documentId**: The id of the document object.
- **fastInstance**: by default it will return a copy of the document.
if you set fastInstance to true, it will return the original document.
This is dangerous but much faster, you should use it only if you know what you are doing.

Expand Down

0 comments on commit 42820e6

Please sign in to comment.