NetlifyExtension

The NetlifyExtension provides different methods to help create your extension.

Review TypeScript definitions in the SDK

When you install the Netlify SDK, you have access to the TypeScript definitions directly in the @netlify/sdk package. You can browse through the definition files individually or review the type definition inline depending on your code editor.

Usage example

src/index.ts

import { NetlifyExtension } from "@netlify/sdk";

const extension = new NetlifyExtension();

// Adding a build event handler
extension.addBuildEventHandler("onPreBuild", () => {
  console.log("This is my first build event handler!");
});

Type parameters

Name	Type
SiteConfigSchema	ZodSchema, undefined
TeamConfigSchema	ZodSchema, undefined
BuildContext	ZodSchema, undefined
BuildConfigSchema	ZodSchema, undefined

Methods

addBuildEventContext

addBuildEventContext(func)

Used to add a build context to the extension that can be used in a build event handler.

Parameters

Name	Type
handler	func

Returns

Returns a promise with an object.

---

addBuildEventHandler

addBuildEventHandler(type, func)

Used to add a build event handler to the extension.

Parameters

Name	Type
type	BuildHookType, one of the build events
func	func

Returns

void

---

addEdgeFunctions

addEdgeFunctions(path, options)

Used to inform the extension that you want to inject edge functions into the user’s project.

Parameters

Name	Type
path	string
options	EdgeFunctionsOptions

Returns

void

---

addFunctions

addFunctions(path, options)

Used to inform the extension that you want to inject functions into the user’s project.

Parameters

Name	Type
path	string
options	FunctionsOptions

Returns

void

Did you find this doc useful?

Your feedback helps us improve our docs.

Don’t fill this out if you’re human:

Send

Got it!

Your feedback helps us improve our docs.

• Netlify
• Careers
• Blog
• Terms
• Privacy