1
0
Fork 0
freesewing/sites/dev/docs/reference/store-methods
BenJamesBen 788ea77ffa
fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052)
* fix(docs): cutlist.removeCut() can remove all cutting instructions

* fix(docs): Add cutlist.setcut doc

* fix(docs): cutlist.addcut() signature and other improvements

* fix(docs): cutlist store methods improvements

* fix(docs) Add missing cutlist store methods

* fix(docs): Remove cutlist store methods docs from old docs location

* fix(docs): Add missing cutlist store methods

---------

Co-authored-by: Benjamin Fan <ben-git@swinglonga.com>
2024-11-16 15:39:49 +01:00
..
cutlist.addcut fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.getcutfabrics fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.getgrainorigin fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.removecut fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.removecutonfold fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.removegrain fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.setcut fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.setcutonfold fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
cutlist.setgrain fix(docs) Add missing cutlist store methods and improve cutlist docs (#7052) 2024-11-16 15:39:49 +01:00
flag.error
flag.fixme
flag.info
flag.note
flag.preset
flag.tip
flag.warn
generatemacroids
getmacroids
log.debug
log.error
log.info
log.warn
pack
removemacronodes
storemacroids
unflag.error
unflag.fixme
unflag.info
unflag.note
unflag.preset
unflag.tip
unflag.warn
readme.mdx

---
title: Store Methods
---

Store methods are typically provided by plugins and attached to
the store to make them available during the drafting process.

Some of FreeSewing's core library functionality is implemented 
as store methods to allow plugins to override this functionality.
Examples include log handling and pattern layout algorithm.

All store methods below are either provided by plugins we maintain,
or are the default store methods as provided by the core library.

## Signature

```js
null method(object Store, object config)
```

A store method receives as its first parameter [the Store object](/reference/api/store), and
as second parameter a single configuration object for the method.

## Store methods we maintain

<ReadMore />