Skip to content

Commit

Permalink
update docs 🐏
Browse files Browse the repository at this point in the history
  • Loading branch information
mesqueeb committed Oct 14, 2018
1 parent 6121763 commit ddd3afa
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@ dispatch('moduleName/delete', `${id}.tags.water`)

In the above example you can see that you can delete a sub-property by passing a string and separate sub-props with `.`

### Auto-generated fields

When working with collections, each document insert or update will automatically receive these fields:

- `created_at` / `updated_at` both use: `Firebase.firestore.FieldValue.serverTimestamp()`
- `created_by` / `updated_by` will automatically fill in the userId

### Manually assigning doc IDs

You can, **but do not need to**, assign doc IDs manually.
Expand All @@ -82,13 +89,6 @@ As you can see in the example above, each vuex-easy-firestore module has a gette

Please note you can also access the ID (even if you don't manually pass it) in the [hooks](https://mesqueeb.github.io/vuex-easy-firestore/extra-features.html#hooks-before-insert-patch-delete).

### Auto-generated fields

When working with collections, each document insert or update will automatically receive these fields:

- `created_at` / `updated_at` both use: `Firebase.firestore.FieldValue.serverTimestamp()`
- `created_by` / `updated_by` will automatically fill in the userId

## 'doc' mode

In 'doc' mode all changes will take effect on the single document you have passed in the firestorePath. You will be able to use these actions:
Expand Down

0 comments on commit ddd3afa

Please sign in to comment.