Azion `Config` module

The Config module provides a function to configure and validate options for Edge Application. It supports various configurations, including domain settings, origin settings, cache settings, rules, network lists, and purge operations.

Go to Azion Libraries Overview

Functions

`defineConfig`

This function configures and validates the options for Azion Edge Application. It receives a configuration object that contains the settings for domains, cache, rules, and more.

Example:

import { defineConfig } from 'azion';

const config = defineConfig({
  origin: [
    {
      name: 'My Origin',
      type: 'single_origin',
      addresses: [
        {
          address: 'origin.example.com',
          weight: 100,
        },
      ],
      protocolPolicy: 'https',
    },
  ],
});

`processConfig`

This function processes the configuration object and returns a manifest.

Example:

import { AzionConfig, processConfig } from 'azion';

const config: AzionConfig = {...};

const manifest = processConfig(config);

console.log(manifest);

`convertJsonConfigToObject`

This function converts a JSON configuration object into an AzionConfig object.

Example:

import { convertJsonConfigToObject } from 'azion';

const manifestJson = {
  origin: [
    {
      name: 'My Origin',
      origin_type: 'single_origin',
      addresses: [
        {
          address: 'origin.example.com',
          weight: 100,
        },
      ],
      origin_protocol_policy: 'https',
    },
  ],
};

const manifest = convertJsonConfigToObject(JSON.stringify(manifestJson));

console.log(manifest);