@kody/netlify

Inspect Netlify sites, deploys, env-var metadata, and forms on the caller's account, with dry-run writes.

src/create-deploy.js

18 lines · 844 B · JavaScript

import { createDeploy } from './netlify.js'

/**
 * Create a site deploy from a file digest or zip body.
 * Requires `dryRun: true` to preview or `confirm: true` to write.
 * Do not set `production: true` unless the caller confirmed a production deploy.
 * @param {Object} input
 * @param {string} input.site Site id, name, or domain.
 * @param {boolean} [input.dryRun] Return the request preview without creating a deploy.
 * @param {boolean} [input.confirm] Required for the live write.
 * @returns {Promise<Record<string, unknown>>} Created deploy or dry-run preview.
 * @example
 * import createDeploy from 'kody:@kody/netlify/create-deploy'
 * const preview = await createDeploy({ site: 'example-site', draft: true, dryRun: true })
 */
export default async function createDeployEntrypoint(input = {}) {
	return await createDeploy(input)
}