Merge pull request #5983 from BenJamesBen/store-log-link
fix(markdown): Update links and docs for new Store Methods doc
This commit is contained in:
commit
e1b5005525
3 changed files with 10 additions and 5 deletions
|
@ -34,7 +34,7 @@ access the following properties:
|
||||||
|| **_Access to utilities_** |
|
|| **_Access to utilities_** |
|
||||||
| `context` | Allows access to the pattern object and other things higher in the tree |
|
| `context` | Allows access to the pattern object and other things higher in the tree |
|
||||||
| `getId` | See [the getId documentation](/reference/api/part/getid) |
|
| `getId` | See [the getId documentation](/reference/api/part/getid) |
|
||||||
| `log` | See [the logging documentation](/reference/api/store/log) |
|
| `log` | See [the Store Methods documentation](/reference/store-methods#store-methods-we-maintain) |
|
||||||
| `macro` | See [the macros documentation](/reference/macros/) |
|
| `macro` | See [the macros documentation](/reference/macros/) |
|
||||||
| `store` | See [the store documentation](/reference/api/store) |
|
| `store` | See [the store documentation](/reference/api/store) |
|
||||||
| `units` | A version of [`utils.units()`](/reference/api/utils/units) that is preconfigured with the user's chosen units |
|
| `units` | A version of [`utils.units()`](/reference/api/utils/units) that is preconfigured with the user's chosen units |
|
||||||
|
|
|
@ -6,12 +6,17 @@ A **Store** object holds a simple key/value store with methods for storing and
|
||||||
retrieving data. It is shared across the pattern, and is the recommended way
|
retrieving data. It is shared across the pattern, and is the recommended way
|
||||||
to pass data between your parts.
|
to pass data between your parts.
|
||||||
|
|
||||||
The store can also be extended with additional methods by plugins. Refer to
|
|
||||||
[the plugin guide](/guides/plugins) for more details.
|
|
||||||
|
|
||||||
## Methods and Properties
|
## Methods and Properties
|
||||||
|
|
||||||
A Store object exposes the following methods and properties:
|
A Store object exposes the following methods and properties:
|
||||||
|
|
||||||
<ReadMore recurse />
|
<ReadMore recurse />
|
||||||
|
|
||||||
|
## Extended store methods
|
||||||
|
|
||||||
|
The store can also be extended with additional methods by plugins.
|
||||||
|
|
||||||
|
- Refer to [the Store Methods documentation](/reference/store-methods)
|
||||||
|
for more information and a list of store methods maintained by FreeSewing.
|
||||||
|
- Refer to [the Plugin guide](/guides/plugins) for information about how
|
||||||
|
plugins can be used to provide store methods.
|
||||||
|
|
|
@ -23,5 +23,5 @@ logs: {
|
||||||
|
|
||||||
Users can override the default logging, so don't assume this is where logs end up.
|
Users can override the default logging, so don't assume this is where logs end up.
|
||||||
|
|
||||||
That's why, you should always use the methods in [Store.log](/reference/api/store/log) to log.
|
That's why, you should always use the [Store.log methods](/reference/store-methods#store-methods-we-maintain) to log.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue