cha0s/flecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: doc

Browse Source
This commit is contained in:
cha0s 2022-03-08 16:16:30 -06:00
parent e33d174d28
commit 0cb9b777d7
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
packages/core/build/dox/concepts/hooks.md
View File

@ -1,6 +1,6 @@
# Hooks
Hooks are how everything happens in flecks. There are many hooks and the hooks provided by flecks are documented at the [hooks reference page](ADDME).
Hooks are how everything happens in flecks. There are many hooks and the hooks provided by flecks are documented at the [hooks reference page](https://github.com/cha0s/flecks/blob/gh-pages/hooks.md).
To define hooks (and turn your plain ol' boring JS modules into beautiful interesting flecks), you only have to import the `Hooks` symbol and key your default export:
@ -67,7 +67,8 @@ Invokes hook implementations one at a time, their results being passed to the re
 
### `invokeSequential(Async)?(hook, ...args)`
### `invokeSequential(hook, ...args)`
### `invokeSequentialAsync(hook, ...args)`
Invokes all hook implementations, one after another. In the async variant, each implementation's result is `await`ed before invoking the next implementation.
@ -124,7 +125,7 @@ Following from the example above:
```javascript
const foo = new Gathered.Foo();
assert(foo.id === 2);
assert(foo.type === 'Foo);
assert(foo.type === 'Foo');
```
`flecks.gather()` also supports some options: