The Config module provides comprehensive configuration and validation for the Azion Platform. It supports applications, workloads, connectors, functions, storage, firewall rules, WAF settings, network lists, custom pages, and purge operations.

Usage

You can configure your Azion application in two ways:

1. Using JSDoc for type information:

/** @type {import('azion').AzionConfig} */
const config = {...}

export default config;

2. Using the defineConfig function:

import { defineConfig } from 'azion/config';

const config = defineConfig({
  build: {
    entry: './src/index.js',
    preset: 'javascript',
  },
  // ... other configurations
});

export default config;

Functions

defineConfig

Configures and validates the options for Azion Applications.

Parameters:

Returns:

Example:

import { defineConfig } from 'azion/config';

const config = defineConfig({
  build: {
    entry: './src/index.js',
    preset: 'javascript',
    bundler: 'esbuild',
  },
  applications: [
    {
      name: 'my-app',
      active: true,
      cache: [
        {
          name: 'my-cache',
          browser: { maxAgeSeconds: 3600 },
          edge: { maxAgeSeconds: 7200 },
        },
      ],
    },
  ],
  storage: [
    {
      name: 'my-storage',
      workloadsAccess: 'read_write',
      dir: './storage',
      prefix: 'app-data',
    },
  ],
});

export default config;

processConfig

Processes the configuration object and returns a manifest.

Parameters:

Returns:

Example:

import { AzionConfig, processConfig } from 'azion';

const config: AzionConfig = {...};

const manifest = processConfig(config);
console.log(manifest);

convertJsonConfigToObject

Converts a JSON configuration string to an AzionConfig object.

Parameters:

Returns:

Example:

import { convertJsonConfigToObject } from 'azion';

const manifestJson = {
  workloads: [
    {
      name: 'my-workload',
      active: true,
      domains: ['example.com'],
    },
  ],
};

const config = convertJsonConfigToObject(JSON.stringify(manifestJson));
console.log(config);

Configuration sections

The AzionConfig object supports the following sections:

Types

AzionConfig

The main configuration object.

AzionBuild

Build configuration options.

AzionApplication

Application configuration.

AzionWorkload

Workload configuration for domain management.

AzionConnector

Connector configuration.

AzionFunction

Function configuration.

AzionStorage

Storage configuration.

AzionCache

Cache configuration.

AzionFirewall

Firewall configuration.

AzionWaf

WAF configuration.

AzionNetworkList

Network list configuration.

AzionPurge

Purge configuration.

AzionKV

KV storage configuration.