interface

Security.Advisory

interface Advisory

The result of a security scan of a package

  • description: null | string

    A brief description of the advisory, which Bun prints to the user. null if none is available.

  • level: 'warn' | 'fatal'

    The severity of the advisory.

    Bun always pretty-prints every advisory returned from the scan() hook, then:

    • if any is fatal, Bun immediately cancels the installation and exits with a non-zero exit code
    • otherwise, if any is warn, Bun asks whether to continue with the install when running in a TTY, and exits immediately when not
  • package: string

    The name of the package being installed.

  • url: null | string

    A URL linking to a CVE or report where users can learn more about the advisory, or null if none is available.