1
0
Fork 0

chore: Updating hooks docs for v3

This commit is contained in:
Joost De Cock 2022-09-29 23:43:00 +02:00
parent 098d23c3b7
commit 2c12227ea8
14 changed files with 288 additions and 47 deletions

View file

@ -4,16 +4,27 @@ title: preSample
The `preSample` hook runs just before your pattern is sampled.
It is triggered at the very start of either:
## Signature
```js
null hook(Pattern pattern)
```
## Example
```js
pattern.on('preSample', pattern => {
// Mutate the pattern object here
}
```
## Notes
The `preSample` hook is rarely used, but it's there if you need it.
It is triggered just before the start of either:
- the [Pattern.sampleOption()](/reference/api/pattern/sampleoption) method
- the [Pattern.sampleMeasurement()](/reference/api/pattern/samplemeasurement) method
- the [Pattern.sampleModels()](/reference/api/pattern/samplemodels) method
Your plugin will receive the Pattern object.
<Note>
The `preSample` hook is rarely used.
</Note>