Namespace createSnap

Callable

• createSnap(userSupplied: SnapcraftOptions & CustomSnapcraftConfig): Promise<string>

• The electron-installer-snap API uses the Promise pattern to perform asynchronous operations.

  Minimal example:

  const snap = require('electron-installer-snap')
  
  const snapPath = await snap(options)
  console.log(`Created snap at ${snapPath}!`)
  

  Full example with Electron Packager:

  const packager = require('electron-packager')
  const snap = require('electron-installer-snap')
  
  const arch = 'x64'
  
  const paths = await packager({dir: '/path/to/app', platform: 'linux', arch: arch})
  const snapPath = await snap({src: paths[0], arch: arch})
  console.log(`Created snap at ${snapPath}!`)
  

  If you need to use the callback pattern instead of the async/await pattern, look into the util.callbackify function.

  Parameters

  • userSupplied: SnapcraftOptions & CustomSnapcraftConfig

  Returns Promise<string>