Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kody/vercel

src/add-domain.js

18 lines · 815 B · JavaScript
import { addDomain } from './vercel.js'

/**
 * Add a domain to a project, or to the account when `project` is omitted.
 * Requires `dryRun: true` to preview or `confirm: true` to write.
 * @param {Object} input
 * @param {string} input.name Domain name.
 * @param {string} [input.project] Project id or name.
 * @param {boolean} [input.dryRun] Return the request preview without adding the domain.
 * @param {boolean} [input.confirm] Required for the live write.
 * @returns {Promise<Record<string, unknown>>} Added domain or dry-run preview.
 * @example
 * import addDomain from 'kody:@kody/vercel/add-domain'
 * const preview = await addDomain({ project: 'example-app', name: 'www.example.com', dryRun: true })
 */
export default async function addDomainEntrypoint(input = {}) {
	return await addDomain(input)
}