NetlifyExtensionBuildClient
Usage example
Section titled “Usage example”This example shows a build event handler that uses the available ACCOUNT_ID
and SITE_ID
constants to do a call using the client
to fetch a site’s config.
This config can hold useful information for the extension, such as an extension’s state, specific configurations on how the extension should function, or keys that can be used to interact with third-party APIs.
import { NetlifyExtension } from '@netlify/sdk';
const extension = new NetlifyExtension();
extension.addBuildEventHandler('onPreBuild', async ({ client, constants }) => { const { ACCOUNT_ID, SITE_ID } = constants; const siteConfig = client.getSiteConfiguration(ACCOUNT_ID, SITE_ID);
// do something with the site configuration});
export { extension };
NetlifyExtensionClient
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
SiteConfiguration |
TeamConfiguration |
Constructors
Section titled “Constructors”new NetlifyExtensionBuildClient()
Section titled “new NetlifyExtensionBuildClient()”new NetlifyExtensionBuildClient<
SiteConfiguration
,TeamConfiguration
>(…params
):NetlifyExtensionBuildClient
<SiteConfiguration
,TeamConfiguration
>
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
…params | [string , string , ExtensionClientOptions? ] |
Returns
Section titled “Returns”NetlifyExtensionBuildClient
<SiteConfiguration
, TeamConfiguration
>
Properties
Section titled “Properties”Property | Type | Description |
---|---|---|
getAccount | (accountId : string ) => Promise <Account > | Link NetlifyClient.getAccount |
getSite | (siteId : string ) => Promise <Site > | Link NetlifyClient.getSite |
getSiteConfiguration | (teamId : string , siteId : string ) => Promise <null | ConfigurationResponse <SiteConfiguration >> | Link NetlifyExtensionClient.getSiteConfiguration |
getTeamConfiguration | (teamId : string ) => Promise <null | ConfigurationResponse <TeamConfiguration >> | Link NetlifyExtensionClient.getTeamConfiguration |