Browse Source

docs: update @electron/fuses code examples (#39202)

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: David Sanders <[email protected]>
trop[bot] 1 year ago
parent
commit
bca09956f3
2 changed files with 7 additions and 3 deletions
  1. 3 1
      docs/tutorial/asar-integrity.md
  2. 4 2
      docs/tutorial/fuses.md

+ 3 - 1
docs/tutorial/asar-integrity.md

@@ -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,
   {

+ 4 - 2
docs/tutorial/fuses.md

@@ -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
@@ -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