Skip to content

Commit

Permalink
docs: update @electron/fuses code examples (electron#39175)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsanders11 authored Jul 24, 2023
1 parent 1ca3a7d commit 2caf080
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/tutorial/asar-integrity.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ Valid `algorithm` values are currently `SHA256` only. The `hash` is a hash of t
ASAR integrity checking is currently disabled by default and can be enabled by toggling a fuse. See [Electron Fuses](fuses.md) for more information on what Electron Fuses are and how they work. When enabling this fuse you typically also want to enable the `onlyLoadAppFromAsar` fuse otherwise the validity checking can be bypassed via the Electron app code search path.

```js @ts-nocheck
require('@electron/fuses').flipFuses(
const { flipFuses, FuseVersion, FuseV1Options } = require('@electron/fuses')

flipFuses(
// E.g. /a/b/Foo.app
pathToPackagedApp,
{
Expand Down
6 changes: 4 additions & 2 deletions docs/tutorial/fuses.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ The loadBrowserProcessSpecificV8Snapshot fuse changes which V8 snapshot file is
We've made a handy module, [`@electron/fuses`](https://npmjs.com/package/@electron/fuses), to make flipping these fuses easy. Check out the README of that module for more details on usage and potential error cases.

```js @ts-nocheck
require('@electron/fuses').flipFuses(
const { flipFuses, FuseVersion, FuseV1Options } = require('@electron/fuses')

flipFuses(
// Path to electron
require('electron'),
// Fuses to flip
Expand All @@ -82,7 +84,7 @@ require('@electron/fuses').flipFuses(
You can validate the fuses have been flipped or check the fuse status of an arbitrary Electron app using the fuses CLI.

```bash
npx @electron/fuses read --app /Applications/Foo.app
npx @electron/fuses read --app /Applications/Foo.app
```

### The hard way
Expand Down

0 comments on commit 2caf080

Please sign in to comment.