SvelteKitReference

@sveltejs/kit/env

import { defineEnvVars(alias) function defineEnvVars<T extends Record<string, EnvVarConfig<any>>>(variables: T): DefinedEnvVars<T>
import defineEnvVarsUtility for defining environment variables,
which are made available via $app/env/public and $app/env/private.
import { defineEnvVars } from '@sveltejs/kit/env';
import * as v from 'valibot';

export const variables = defineEnvVars({
	API_URL: {
		schema: v.pipe(v.string(), v.url())
	},
	PORT: {
		schema: (value) => {
			if (value === undefined) return 3000;
			const port = Number(value);
			if (!Number.isInteger(port)) throw new Error('PORT must be an integer');
			return port;
		}
	}
});reference } from '@sveltejs/kit/env';

defineEnvVars

Utility for defining environment variables, which are made available via $app/env/public and $app/env/private.

import { defineEnvVars(alias) function defineEnvVars<T extends Record<string, EnvVarConfig<any>>>(variables: T): DefinedEnvVars<T>
import defineEnvVarsUtility for defining environment variables,
which are made available via $app/env/public and $app/env/private.
import { defineEnvVars } from '@sveltejs/kit/env';
import * as v from 'valibot';

export const variables = defineEnvVars({
	API_URL: {
		schema: v.pipe(v.string(), v.url())
	},
	PORT: {
		schema: (value) => {
			if (value === undefined) return 3000;
			const port = Number(value);
			if (!Number.isInteger(port)) throw new Error('PORT must be an integer');
			return port;
		}
	}
});reference } from '@sveltejs/kit/env';
import * as vimport v from 'valibot';

export const variablesconst variables: DefinedEnvVars<{
    API_URL: {
        schema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
    };
    PORT: {
        schema: (value: string | undefined) => number;
    };
}> = defineEnvVars(alias) defineEnvVars<{
    API_URL: {
        schema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
    };
    PORT: {
        schema: (value: string | undefined) => number;
    };
}>(variables: {
    API_URL: {
        schema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
    };
    PORT: {
        schema: (value: string | undefined) => number;
    };
}): DefinedEnvVars<{
    API_URL: {
        schema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
    };
    PORT: {
        schema: (value: string | undefined) => number;
    };
}>
import defineEnvVarsUtility for defining environment variables,
which are made available via $app/env/public and $app/env/private.
import { defineEnvVars } from '@sveltejs/kit/env';
import * as v from 'valibot';

export const variables = defineEnvVars({
	API_URL: {
		schema: v.pipe(v.string(), v.url())
	},
	PORT: {
		schema: (value) => {
			if (value === undefined) return 3000;
			const port = Number(value);
			if (!Number.isInteger(port)) throw new Error('PORT must be an integer');
			return port;
		}
	}
});reference({
	API_URL(property) API_URL: {
    schema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
}: {
		schema(property) schema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>: vimport v.pipe(alias) pipe<v.StringSchema<undefined>, v.UrlAction<string, undefined>>(schema: v.StringSchema<undefined>, item1: v.UrlAction<string, undefined> | v.PipeAction<string, string, v.UrlIssue<string>>): v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]> (+20 overloads)
export pipeAdds a pipeline to a schema, that can validate and transform its input.
schema The root schema.
item1 The first pipe item.
A schema with a pipeline.
(vimport v.string(alias) string(): v.StringSchema<undefined> (+1 overload)
export stringCreates a string schema.
A string schema.
(), vimport v.url(alias) url<string>(): v.UrlAction<string, undefined> (+1 overload)
export urlCreates an URL validation action.
Hint: The value is passed to the URL constructor to check if it is valid.
This check is not perfect. For example, values like "abc:1234" are accepted.
An URL action.
())
	},
	PORT(property) PORT: {
    schema: (value: string | undefined) => number;
}: {
		schema(property) schema: (value: string | undefined) => number: (value(parameter) value: string | undefined) => {
			if (value(parameter) value: string | undefined === undefinedvar undefined) return 3000;
			const portconst port: number = Numbervar Number: NumberConstructor
(value?: any) => numberAn object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers.
(value(parameter) value: string);
			if (!Numbervar Number: NumberConstructorAn object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers.
.isInteger(method) NumberConstructor.isInteger(number: unknown): booleanReturns true if the value passed is an integer, false otherwise.
number A numeric value.
(portconst port: number)) throw new Errorvar Error: ErrorConstructor
new (message?: string, options?: ErrorOptions) => Error (+1 overload)('PORT must be an integer');
			return portconst port: number;
		}
	}
});

function defineEnvVars<
	T extends Record<string, EnvVarConfig<any>>
>(variables: T): DefinedEnvVars<T>;

DefinedEnvVars

The return type of defineEnvVars.

type DefinedEnvVars<
	T extends Record<string, EnvVarConfig<any>>
> = {
	readonly [K in keyof T]: EnvVarEntry<T[K]>;
};

EnvVarConfig

Environment variables can be configured by exporting a variables object from src/env.ts, using defineEnvVars.

interface EnvVarConfig<T> {/*…*/}

public?: boolean;

default false

Whether the environment variable can be accessed by client-side code.

if true, it can be imported from $app/env/public
if false, it can be imported from $app/env/private, which is a server-only module

static?: boolean;

default false

Whether the value is determined at build time or when the app runs.

if true, the build time value is inlined into the bundle. This enables optimisations like dead-code elimination
if false, the value is read from the environment when the app starts

schema?: StandardSchemaV1<string | undefined, T> | ((value: string | undefined) => T | undefined);

A Standard Schema validator that is applied to the value when the app starts. Alternatively, a function that returns the (possibly transformed) value, or throws an error explaining the problem. Returning undefined is valid, so a function can describe an optional variable. The validator can output any value — not necessarily a string — but public, non-static values must be serializable by devalue so that they can be sent to the browser.

If omitted, the value must be set, but may be an empty string.

description?: string;

A description of the variable that will be used for inline documentation on hover.

Edit this page on GitHub llms.txt

previous next

@sveltejs/kit/adapter @sveltejs/kit/hooks