The Azion Libraries provide a suite of tools to interact with various Azion services, including Products (Purge, SQL, Storage) and Utilities (WASM Image Processor, Cookies). Each library is configurable and supports debug mode and environment variable-based configuration.
These libraries are designed to be versatile and can be used both within and outside of the Azion Runtime environment. When used outside of the Azion Runtime, the libraries will interact with Azion services via REST APIs. However, when used within the Azion Runtime
, the libraries will leverage internal runtime capabilities for enhanced performance and efficiency.
Install the package using npm or yarn:
npm install azion
or
yarn add azion
The Azion Client provides a unified interface to interact with all Azion services.
JavaScript:
import { createClient } from 'azion';
const client = createClient({ token: 'your-api-token', debug: true });
// Storage
const newBucket = await client.storage.createBucket('my-new-bucket', 'public');
console.log(`Bucket created with name: ${newBucket.name}`);
const allBuckets = await client.storage.getBuckets();
console.log(`Retrieved ${allBuckets.length} buckets`);
// SQL
const newDatabase = await client.sql.createDatabase('my-new-db');
console.log(`Database created with ID: ${newDatabase.id}`);
const allDatabases = await client.sql.getDatabases();
console.log(`Retrieved ${allDatabases.length} databases`);
// Purge
const purgeResult = await client.purge.purgeURL(['http://example.com/image.jpg']);
console.log(`Purge successful: ${purgeResult.items}`);
TypeScript:
import { createClient } from 'azion';
import { AzionClient, Bucket, Database, Purge } from 'azion/types';
const client: AzionClient = createClient({ token: 'your-api-token', debug: true });
// Storage
const newBucket: Bucket | null = await client.storage.createBucket('my-new-bucket', 'public');
console.log(`Bucket created with name: ${newBucket.name}`);
const allBuckets: Bucket[] | null = await client.storage.getBuckets();
console.log(`Retrieved ${allBuckets.length} buckets`);
// SQL
const newDatabase: Database | null = await client.sql.createDatabase('my-new-db');
console.log(`Database created with ID: ${newDatabase.id}`);
const allDatabases: Database[] | null = await client.sql.getDatabases();
console.log(`Retrieved ${allDatabases.length} databases`);
// Purge
const purgeResult: Purge | null = await client.purge.purgeURL(['http://example.com/image.jpg']);
console.log(`Purge successful: ${purgeResult.items}`);
The Storage library provides methods to interact with Azion Edge Storage.
JavaScript:
import { createClient } from 'azion/storage';
const client = createClient({ token: 'your-api-token', debug: true });
const newBucket = await client.createBucket('my-new-bucket', 'public');
if (newBucket) {
console.log(`Bucket created with name: ${newBucket.name}`);
}
const allBuckets = await client.getBuckets();
if (allBuckets) {
console.log(`Retrieved ${allBuckets.length} buckets`);
}
TypeScript:
import { createClient } from 'azion/storage';
import { StorageClient, Bucket } from 'azion/storage/types';
const client: StorageClient = createClient({ token: 'your-api-token', debug: true });
const newBucket: Bucket | null = await client.createBucket('my-new-bucket', 'public');
if (newBucket) {
console.log(`Bucket created with name: ${newBucket.name}`);
}
const allBuckets: Bucket[] | null = await client.getBuckets();
if (allBuckets) {
console.log(`Retrieved ${allBuckets.length} buckets`);
}
Read more in the Storage README.
The SQL library provides methods to interact with Azion Edge SQL databases.
JavaScript:
import { createClient } from 'azion/sql';
const client = createClient({ token: 'your-api-token', debug: true });
const newDatabase = await client.createDatabase('my-new-db');
if (newDatabase) {
console.log(`Database created with ID: ${newDatabase.id}`);
}
const allDatabases = await client.getDatabases();
if (allDatabases) {
console.log(`Retrieved ${allDatabases.length} databases`);
}
TypeScript:
import { createClient } from 'azion/sql';
import { SQLClient, Database } from 'azion/sql/types';
const client: SQLClient = createClient({ token: 'your-api-token', debug: true });
const newDatabase: Database | null = await client.createDatabase('my-new-db');
if (newDatabase) {
console.log(`Database created with ID: ${newDatabase.id}`);
}
const allDatabases: Database[] | null = await client.getDatabases();
if (allDatabases) {
console.log(`Retrieved ${allDatabases.length} databases`);
}
Read more in the SQL README.
The Purge library provides methods to purge URLs, Cache Keys, and Wildcard expressions from the Azion Edge cache.
JavaScript:
import { createClient } from 'azion/purge';
const client = createClient({ token: 'your-api-token', debug: true });
const purgeResult = await client.purgeURL(['http://example.com/image.jpg']);
if (purgeResult) {
console.log(`Purge successful: ${purgeResult.items}`);
}
const cacheKeyResult = await client.purgeCacheKey(['my-cache-key-1', 'my-cache-key-2']);
if (cacheKeyResult) {
console.log(`Cache key purge successful: ${cacheKeyResult.items}`);
}
TypeScript:
import { createClient } from 'azion/purge';
import { PurgeClient, Purge } from 'azion/purge/types';
const client: PurgeClient = createClient({ token: 'your-api-token', debug: true });
const purgeResult: Purge | null = await client.purgeURL(['http://example.com/image.jpg']);
if (purgeResult) {
console.log(`Purge successful: ${purgeResult.items}`);
}
const cacheKeyResult: Purge | null = await client.purgeCacheKey(['my-cache-key-1', 'my-cache-key-2']);
if (cacheKeyResult) {
console.log(`Cache key purge successful: ${cacheKeyResult.items}`);
}
Read more in the Purge README.
The Cookies library provides methods to get and set cookies.
JavaScript:
import { getCookie, setCookie } from 'azion/cookies';
const myCookie = getCookie(request, 'my-cookie');
setCookie(response, 'my-cookie', 'cookie-value', { maxAge: 3600 });
TypeScript:
import { getCookie, setCookie } from 'azion/cookies';
import { CookieOptions } from 'azion/cookies/types';
const myCookie: string | undefined = getCookie(request, 'my-cookie');
const options: CookieOptions = { maxAge: 3600 };
setCookie(response, 'my-cookie', 'cookie-value', options);
Read more in the Cookies README.
The WASM Image Processor library provides methods to process images using WebAssembly.
JavaScript:
import { loadImage } from 'azion/wasm-image-processor';
const image = await loadImage('https://example.com/image.jpg');
image.resize(0.5, 0.5);
const image = image.getImageResponse('jpeg');
console.log(imageResponse);
TypeScript:
import { loadImage } from 'azion/wasm-image-processor';
import { WasmImage } from 'azion/wasm-image-processor/types';
const image: WasmImage = await loadImage('https://example.com/image.jpg');
image.resize(0.5, 0.5);
const imageResponse = image.getImageResponse('jpeg');
console.log(imageResponse);
Read more in the WASM Image Processor README.
The Utils package provides a set of utility functions that simplify common tasks when working with Azion edge functions.
-
mountSPA(requestURL: RequestURL): Promise<Response>
Handles routing for Single-page Applications (SPA) by determining if the incoming request is for a static asset or an application route. It mounts the appropriate request URL for fetching the required resource. -
mountMPA(requestURL: RequestURL): Promise<Response>
Handles routing for Multi-page Applications (MPA) by determining if the incoming request is for a static asset or an application route. It mounts the appropriate request URL for fetching the required resource. -
parseRequest(event: FetchEvent): Promise<ParsedRequest>
Parses and logs the details of an incoming request, extracting key information such as headers, cookies, body, and client data. It provides a structured object with these details for further processing or logging.
JavaScript:
import { mountSPA, mountMPA, parseRequest } from 'azion/utils';
// Handle SPA routing
const myApp1 = await mountSPA('https://example.com/');
console.log(myApp1);
// Fetches: file:///index.html
// Response object representing the content of index.html
// Handle MPA routing
const myApp2 = await mountMPA('https://example.com/about');
console.log(myApp2);
// Fetches: file:///about/index.html
// Response object representing the content of about/index.html
// Parse a request
const parsedRequest = await parseRequest(event);
console.log(parsedRequest);
TypeScript:
import { mountSPA, mountMPA, parseRequest } from 'azion/utils';
import { ParsedRequest } from 'azion/utils/types';
// Handle SPA routing
const myApp1: Response = await mountSPA('https://example.com/');
console.log(myApp1);
// Fetches: file:///index.html
// Response object representing the content of index.html
// Handle MPA routing
const myApp2: Response = await mountMPA('https://example.com/about');
console.log(myApp2);
// Fetches: file:///about/index.html
// Response object representing the content of about/index.html
// Parse a request
const parsedRequest: ParsedRequest = await parseRequest(event);
console.log(parsedRequest);
Read more in the Utils README.
The Types package provides global TypeScript types that are used across Azion platform, ensuring consistency and reducing redundancy throughout the codebase.
Azion Runtime environments
.
-
Metadata
Represents metadata information for requests, including GeoIP data, remote address, server protocol, and TLS information. -
FetchEvent
Represents the FetchEvent interface, which includes the request object and methods to handle fetch events within the Azion Runtime. -
FirewallEvent
Represents the FirewallEvent interface, including methods to manage firewall events such as denying, dropping, or continuing a request.
Read more in the Types README.
The Config library provides methods to configure and validate options for the Azion platform.
JavaScript:
This is the first example using JSDoc to provide type information:
/** @type {import('azion').AzionConfig} */
const config = {
domain: {},
origin: [],
cache: [],
rules: [],
purge: [],
};
export default config;
This is the second example using the defineConfig
function to enforce types and provide configuration:
import { defineConfig } from 'azion';
const config = defineConfig({
domain: {},
origin: [],
cache: [],
rules: [],
purge: [],
});
export default config;
Read more in the AzionConfig README.
Feel free to submit issues or pull requests to improve the functionality or documentation.