From 3c3753e02ad57ec72c259ca9398313b39b9c6f52 Mon Sep 17 00:00:00 2001 From: rubinovitz Date: Tue, 9 Mar 2021 21:05:27 -0800 Subject: [PATCH 1/4] docs(README): add debugging tips to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2e59293c..e2e034c1 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,16 @@ This hook returns the current database client with some helpful functions for sy Check out the [Firebase example](https://homebaseio.github.io/homebase-react/#!/example.todo_firebase) for a demonstration of how you might integrate a backend. +## Debugging tips + +If you set `debug` to `true` in your configuration, you will be able to access the `_recentlyTouchedAttributes` attribute on entities. `_recentlyTouchedAttributes` will show any cached attributes for a given entity. This is helpful for approximating that entity's schema and values. + +```js + + + +``` + ## Roadmap 1. Document integration with more backends From 854b5096b8067f8ddecb8417d53d55336571f0ff Mon Sep 17 00:00:00 2001 From: rubinovitz Date: Tue, 9 Mar 2021 21:08:36 -0800 Subject: [PATCH 2/4] Update 0400|API.md --- docs/0400|API.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/0400|API.md b/docs/0400|API.md index d69912e4..9b1f30d3 100644 --- a/docs/0400|API.md +++ b/docs/0400|API.md @@ -202,3 +202,13 @@ JSON.parse(company.get('matrix')) ``` For more information check out the [JSON Derived Relationships blog post](https://homebase.io/blog/homebase-react-0.5.0-json-derived-relationships) + +## Debugging tips + +If you set `debug` to `true` in your configuration, you will be able to access the `_recentlyTouchedAttributes` attribute on entities. `_recentlyTouchedAttributes` will show any cached attributes for a given entity. This is helpful for approximating that entity's schema and values. + +```js + + + +``` From 169883ab27c7a155552c741acde41e6a6fcb0967 Mon Sep 17 00:00:00 2001 From: rubinovitz Date: Wed, 10 Mar 2021 10:56:24 -0800 Subject: [PATCH 3/4] move debugging tips on website into homebase provider docs --- docs/0400|API.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/0400|API.md b/docs/0400|API.md index 9b1f30d3..14382743 100644 --- a/docs/0400|API.md +++ b/docs/0400|API.md @@ -18,6 +18,11 @@ const config = { } }, + // Set `debug` to true in order to access the _recentlyTouchedAttributes attribute on your entities + // _recentlyTouchedAttributes shows any cached attributes for a given entity + // This is helpful for approximating that entity's schema and values + debug: true, + // Initial data is what it sounds like. // It's a transaction that runs on component mount. // Use it to hydrate your app. @@ -203,12 +208,4 @@ JSON.parse(company.get('matrix')) For more information check out the [JSON Derived Relationships blog post](https://homebase.io/blog/homebase-react-0.5.0-json-derived-relationships) -## Debugging tips - -If you set `debug` to `true` in your configuration, you will be able to access the `_recentlyTouchedAttributes` attribute on entities. `_recentlyTouchedAttributes` will show any cached attributes for a given entity. This is helpful for approximating that entity's schema and values. -```js - - - -``` From f8ce100a8eeb9a7f1a291ebadb50fa018d12dc0a Mon Sep 17 00:00:00 2001 From: rubinovitz Date: Wed, 10 Mar 2021 10:57:05 -0800 Subject: [PATCH 4/4] remove whitespace from API website page --- docs/0400|API.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/0400|API.md b/docs/0400|API.md index 14382743..9572a5a5 100644 --- a/docs/0400|API.md +++ b/docs/0400|API.md @@ -207,5 +207,3 @@ JSON.parse(company.get('matrix')) ``` For more information check out the [JSON Derived Relationships blog post](https://homebase.io/blog/homebase-react-0.5.0-json-derived-relationships) - -