Vercel/aliases
@swamp/vercel/aliasesv2026.10.23.1
01README
Vercel aliases infrastructure models
02Release Notes
- Updated: aliases
03Behaviors
@swamp/vercel/aliases/aliasesv2026.10.23.1aliases.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| teamId? | string | Vercel team ID |
| slug? | string | Vercel team slug (alternative to teamId) |
| id | string | Deployment ID to create the alias for |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| alias? | string | The alias we want to assign to the deployment defined in the URL |
| redirect? | string | The redirect property will take precedence over the deployment id from the URL and consists of a hostname (like test.com) to which the alias should redirect using status code 307 |
| token? | string | Vercel API token; overrides the VERCEL_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
fn create()
Create a Aliases
fn get(id: string)
Get a Aliases
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Aliases |
fn lookup(allowMissing?: boolean)
Look up an existing Aliases by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Aliases by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Aliases to import |
fn delete(id: string)
Delete the Aliases
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Aliases |
fn sync(identifier?: string)
Sync Aliases state from Vercel
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Aliases by uid (e.g. one discovered by list) |
Resources
state(infinite)— Aliases resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.2AGPL-3.0-or-later
- Updated: aliases
2026.10.20.1AGPL-3.0-or-later(was none)
- Updated: aliases
Modified 1 behaviors
2026.10.13.1
- Updated: aliases
2026.09.16.1
- Updated: aliases
2026.08.03.4
- Updated: aliases
2026.08.03.3
- Updated: aliases
05Stats
A
100 / 100
Downloads
68
Archive size
10.3 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