Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add prestart hook documentation #204

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions config/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,28 @@ You can use this hook to generate any static files or resources your app require

For instance, you could use this hook to generate a license file containing the license of all your dependencies.

### `preStart`

* **Arguments:**
* **`config:`**[**`ResolvedForgeConfig`**](https://js.electronforge.io/interfaces/\_electron\_forge\_shared\_types.ResolvedForgeConfig.html) - Forge configuration object
* **Returns: `Promise<void>`**

`preStart()` is invoked before Forge's **`start`** command launches the app in dev mode.

You can use this hook to run prepatory logic before your app launches.

{% code title="forge.config.js" fullWidth="false" %}
```javascript
module.exports = {
hooks: {
preStart: async (forgeConfig) => {
console.log(`Starting up app on platform: ${process.platform}`);
}
}
};
```
{% endcode %}

### `postStart`

* **Arguments:**
Expand Down