Module: index

Table of contents

Interfaces

• DangerouslyDeleteOptions
• Geo
• PurgeApi
• Request
• RuntimeCache

Type Aliases

• AddCacheTagApi

Functions

• addCacheTag
• attachDatabasePool
• dangerouslyDeleteBySrcImage
• dangerouslyDeleteByTag
• experimental_attachDatabasePool
• geolocation
• getCache
• getEnv
• invalidateBySrcImage
• invalidateByTag
• ipAddress
• next
• rewrite
• waitUntil

Type Aliases

AddCacheTagApi

Ƭ AddCacheTagApi: (tag: string | string[]) => Promise<void>

Type declaration

▸ (tag): Promise<void>

Vercel AddCacheTag API. A function that adds one or more tags to the cache content.

Parameters

Returns

Promise<void>

A promise that resolves when the tag is added.

Defined in

packages/functions/src/addcachetag/types.ts:8

Functions

addCacheTag

▸ addCacheTag(tag): Promise<void>

Parameters

Returns

Promise<void>

Defined in

packages/functions/src/addcachetag/index.ts:3

attachDatabasePool

▸ attachDatabasePool(dbPool): void

Call this function right after creating a database pool with the database pool object as argument. This ensures that the current function instance stays alive long enough for idle database connections to be removed from the pool.

Example

const pgPool = new Pool({
  connectionString: process.env.DATABASE_URL,
});
attachDatabasePool(pgPool);

Parameters

Returns

void

Defined in

packages/functions/src/db-connections/index.ts:225

dangerouslyDeleteBySrcImage

▸ dangerouslyDeleteBySrcImage(src, options?): Promise<void>

Parameters

Returns

Promise<void>

Defined in

packages/functions/src/purge/index.ts:28

dangerouslyDeleteByTag

▸ dangerouslyDeleteByTag(tag, options?): Promise<void>

Parameters

Returns

Promise<void>

Defined in

packages/functions/src/purge/index.ts:12

experimental_attachDatabasePool

▸ experimental_attachDatabasePool(dbPool): void

Deprecated

Use attachDatabasePool instead.

Parameters

Returns

void

Defined in

packages/functions/src/db-connections/index.ts:225

geolocation

▸ geolocation(request): Geo

Returns the location information for the incoming request.

Example

import { geolocation } from '@vercel/functions';

export function GET(request) {
  const details = geolocation(request);
  return Response.json(details);
}

Parameters

Returns

Geo

The location information of the request, in this way:

{
 "city": "New York",
 "country": "US",
 "flag": "🇺🇸",
 "countryRegion": "NY",
 "region": "iad1",
 "latitude": "40.7128",
 "longitude": "-74.0060"
 "postalCode": "10001"
}

Defined in

packages/functions/src/headers.ts:180

getCache

▸ getCache(cacheOptions?): RuntimeCache

Retrieves the Vercel Runtime Cache.

Keys are hashed to ensure they are unique and consistent. The hashing function can be overridden by providing a custom keyHashFunction in the cacheOptions parameter.

To specify a namespace for the cache keys, you can pass a namespace option in the cacheOptions parameter. If a namespace is provided, the cache keys will be prefixed with the namespace followed by a separator (default is $). The namespaceSeparator can also be customized using the namespaceSeparator option.

Throws

If no cache is available in the context and InMemoryCache cannot be created.

Parameters

Returns

RuntimeCache

An instance of the Vercel Runtime Cache.

Defined in

packages/functions/src/cache/index.ts:33

getEnv

▸ getEnv(env?): Object

Get System Environment Variables exposed by Vercel.

See

https://vercel.com/docs/projects/environment-variables/system-environment-variables#system-environment-variables

Parameters

Returns

Object

Defined in

packages/functions/src/get-env.ts:6

invalidateBySrcImage

▸ invalidateBySrcImage(src): Promise<void>

Parameters

Returns

Promise<void>

Defined in

packages/functions/src/purge/index.ts:23

invalidateByTag

▸ invalidateByTag(tag): Promise<void>

Parameters

Returns

Promise<void>

Defined in

packages/functions/src/purge/index.ts:4

ipAddress

▸ ipAddress(input): string | undefined

Returns the IP address of the request from the headers.

Example

import { ipAddress } from '@vercel/functions';

export function GET(request) {
  const ip = ipAddress(request);
  return new Response(`Your IP is ${ip}`);
}

Parameters

Returns

string | undefined

The IP address of the request.

Defined in

packages/functions/src/headers.ts:131

next

▸ next(init?): Response

Returns a Response that instructs the system to continue processing the request.

Example

import { next } from '@vercel/edge';

export default function middleware(_req: Request) {
  return next();
}

Example

import { next } from '@vercel/edge';

export default function middleware(_req: Request) {
  return next({
    headers: { 'x-from-middleware': 'true' },
  });
}

Parameters

Returns

Response

Defined in

packages/functions/src/middleware.ts:145

rewrite

▸ rewrite(destination, init?): Response

Returns a response that rewrites the request to a different URL.

Example

import { rewrite, next } from '@vercel/edge';

export default async function middleware(req: Request) {
  const flagged = await getFlag(req, 'isExperimental');
  if (flagged) {
    const url = new URL(req.url);
    url.pathname = `/experimental{url.pathname}`;
    return rewrite(url);
  }

  return next();
}

Example

import { rewrite, next } from '@vercel/edge';

export default function middleware(req: Request) {
  const auth = checkJwt(req.headers.get('Authorization'));
  if (!checkJwt) {
    return rewrite(new URL('/api/error-unauthorized', req.url));
  }
  const url = new URL(req.url);
  url.searchParams.set('_userId', auth.userId);
  return rewrite(url);
}

export const config = { matcher: '/api/users/:path*' };

Parameters

Returns

Response

Defined in

packages/functions/src/middleware.ts:101

waitUntil

▸ waitUntil(promise): undefined | void

Extends the lifetime of the request handler for the lifetime of the given Promise

See

https://developer.mozilla.org/en-US/docs/Web/API/ExtendableEvent/waitUntil

Example

import { waitUntil } from '@vercel/functions';

export function GET(request) {
  waitUntil(fetch('https://vercel.com'));
  return new Response('OK');
}

Parameters

Returns

undefined | void

Defined in

packages/functions/src/wait-until.ts:19