@jgoz/esbuild-overlay
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    @jgoz/esbuild-overlay

    A dismissable error overlay for reporting esbuild errors to a web browser.

    Features

    • Supports esbuild's message format
    • Dismissable

    Install

    This package isn't really intended to be used on its own because it's bundled with @jgoz/esbuild-plugin-livereload and will be used without any configuration.

    $ npm i @jgoz/esbuild-overlay

    Usage with an EventSource

    async function init() {
      const { overlay } = await import('@jgoz/esbuild-overlay');
    
      const evt = new EventSource('/my-event-source');
      let removeOverlay;
    
      evt.addEventListener('build-result', e => {
        const result = JSON.parse(e?.data ?? '{}');
        if (removeOverlay && !result.errors.length) {
          removeOverlay();
          removeOverlay = undefined;
        }
        if (result.errors?.length) {
          removeOverlay = overlay({ errors: result.errors });
        }
      });
    }

    API

    function overlay(props: OverlayProps): () => void

    Displays an overlay with the supplied error messages and returns a function that removes the overlay.

    Name Type Default Description
    errors (*) Message[] - Error messages to display.
    openFileURL string - If provided, this URL will be opened when the user clicks on the overlay.

    This can be used to open the source file of the error or warning.

    Install

    npm i @jgoz/esbuild-overlay

    DownloadsWeekly Downloads

    5

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    143 kB

    Total Files

    13

    Last publish

    Collaborators

    • jgoz