npm.io
16.0.4 • Published 1 month ago

@netlify/edge-bundler

Licence
MIT
Version
16.0.4
Deps
17
Size
3.6 MB
Vulns
0
Weekly
0
Stars
258

Build Node

Edge Bundler

Prepare Netlify Edge Functions for deployment

Usage

  1. Install this module as a dependency in your project

    npm install @netlify/edge-bundler --save
  2. Import it and create a bundle from a directory of Edge Functions and a list of declarations.

    import { bundle } from '@netlify/edge-bundler'
    
    // List of directories to search for Edge Functions.
    const sourceDirectories = ['/repo/netlify/edge-functions', '/repo/.netlify/edge-functions']
    
    // Directory where bundle should be placed.
    const distDirectory = '/repo/.netlify/edge-functions-dist'
    
    // List of Edge Functions declarations.
    const declarations = [
      { function: 'user-1', path: '/blog/*' },
      { function: 'internal-2', path: '/' },
    ]
    
    await bundle(sourceDirectories, distDirectory, declarations)

Vendored modules

To avoid pulling in additional dependencies at runtime, this package vendors some Deno modules in the deno/vendor directory.

This will go away soon as we move away from the ESZIP format.

The eszip module contains a set of custom changes that diverge from the upstream. If you need to update this module, make sure to backport them.

Contributors

Please see CONTRIBUTING.md for instructions on how to set up and work on this repository. Thanks for contributing!