Skip to main content

Vercel/environment

@swamp/vercel/environmentv2026.10.23.1· AGPL-3.0-or-later· 8d agoBEHAVIORS
01README

Vercel environment infrastructure models

02Release Notes
  • Updated: env
  • Updated: custom_environments
03Behaviors2
@swamp/vercel/environment/custom-environmentsv2026.10.23.1custom_environments.ts

Global Arguments

ArgumentTypeDescription
teamId?stringVercel team ID
slug?stringVercel team slug (alternative to teamId)
idOrNamestringThe unique project identifier or the project name
resourceSlug?stringThe slug of the custom environment to create.
description?stringDescription of the custom environment. This is optional.
branchMatcher?objectHow we want to determine a matching branch. This is optional.
copyEnvVarsFrom?stringWhere to copy environment variables from. This is optional.
token?stringVercel API token; overrides the VERCEL_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a Custom Environments
fn get(id: string)
Get a Custom Environments
ArgumentTypeDescription
idstringThe ID of the Custom Environments
fn lookup(allowMissing?: boolean)
Look up an existing Custom Environments by matching global argument values and import it into state
ArgumentTypeDescription
allowMissing?booleanSucceed and record found: false in lookupResult when nothing matches, instead of failing
fn adopt(id: string)
Import an existing Custom Environments by ID into state for management
ArgumentTypeDescription
idstringThe ID of the Custom Environments to import
fn update(identifier?: string)
Update Custom Environments attributes
ArgumentTypeDescription
identifier?stringTarget a specific Custom Environments by id (e.g. one discovered by list)
fn delete(id: string)
Delete the Custom Environments
ArgumentTypeDescription
idstringThe ID of the Custom Environments
fn sync(identifier?: string)
Sync Custom Environments state from Vercel
ArgumentTypeDescription
identifier?stringTarget a specific Custom Environments by id (e.g. one discovered by list)

Resources

state(infinite)— Custom Environments resource state
lookupResult(infinite)— Outcome of the most recent lookup
@swamp/vercel/environment/envv2026.10.23.1env.ts

Global Arguments

ArgumentTypeDescription
teamId?stringVercel team ID
slug?stringVercel team slug (alternative to teamId)
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
evs?array
type?enumThe type of environment variable
target?arrayThe target environment of the Shared Environment Variable
projectId?arrayAssociate a Shared Environment Variable to projects.
token?stringVercel API token; overrides the VERCEL_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a Env
fn get(id: string)
Get a Env
ArgumentTypeDescription
idstringThe ID of the Env
fn lookup(allowMissing?: boolean)
Look up an existing Env by matching global argument values and import it into state
ArgumentTypeDescription
allowMissing?booleanSucceed and record found: false in lookupResult when nothing matches, instead of failing
fn adopt(id: string)
Import an existing Env by ID into state for management
ArgumentTypeDescription
idstringThe ID of the Env to import
fn sync(identifier?: string)
Sync Env state from Vercel
ArgumentTypeDescription
identifier?stringTarget a specific Env by id (e.g. one discovered by list)

Resources

state(infinite)— Env resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions10
2026.10.20.2AGPL-3.0-or-later
  • Updated: env
2026.10.20.1AGPL-3.0-or-later
  • Updated: env
  • Updated: custom_environments

Modified 2 behaviors

2026.10.17.1AGPL-3.0-or-later(was none)
  • Updated: custom_environments
2026.10.13.1
  • Updated: env
  • Updated: custom_environments
2026.10.02.1
  • Updated: custom_environments
2026.10.01.1
  • Updated: env
  • Updated: custom_environments
2026.09.24.1
  • Updated: env
2026.09.16.1
  • Updated: env
  • Updated: custom_environments
2026.08.03.4
  • Updated: env
  • Updated: custom_environments
2026.08.03.3
  • Updated: env
  • Updated: custom_environments
05Stats
A
100 / 100
Downloads
60
Archive size
13.5 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels