@rtorcato/cf-common

Type Aliases

Env

Env = Record<string, unknown>

Defined in: index.ts:7

A Workers env object: the bindings + vars record passed to fetch, scheduled, queue, etc. Each binding's type is unknown until you name it.

Functions

getBinding()

getBinding<T>(env, name): T

Defined in: index.ts:18

Read a binding (KV, R2, D1, queue, service, Durable Object, …) from env by name. Throws a non-exposed 500 when it's missing — a missing binding is a deploy-time misconfiguration (a forgotten wrangler.toml entry), never a client error.

Type Parameters

T

T

Parameters

env

Env

name

string

Returns

T

Example

const kv = getBinding<KVNamespace>(env, 'SESSIONS')

---

requireEnv()

requireEnv(env, name): string

Defined in: index.ts:33

Read a required string var/secret from env. Throws a non-exposed 500 when it is unset or empty.

Parameters

env

Env

name

string

Returns

string

---

getEnv()

getEnv(env, name, fallback?): string | undefined

Defined in: index.ts:48

Read an optional string var from env, returning fallback (default undefined) when it is unset or empty.

Parameters

env

Env

name

string

fallback?

string

Returns

string | undefined