Client

Cliente da Azion Lib, do pacote azion, que acessa Storage, SQL, Purge, Domains, Applications e AI por meio de um único objeto.

Última atualização

Ver como Markdown Configurar agente

O pacote azion contém o cliente da Azion Lib. A função createClient dele retorna um objeto que reúne um cliente para cada um de seis módulos: Storage, SQL, Purge, Domains, Applications e AI. Você passa o seu token uma única vez, para createClient. O pacote azion recebe apenas correções de bugs, e a manutenção dele termina em dezembro de 2026.

Instale o pacote:

npm install azion

Os exemplos desta página são módulos ES em JavaScript e TypeScript que usam await de nível superior, e eles rodam no Node.js. Os exemplos em TypeScript importam tipos com import type, o que os mantém carregáveis quando as anotações de tipo são removidas.

Autenticação

O cliente recebe o seu personal token no campo token de createClient. Uma função chamada diretamente do pacote de um módulo, sem cliente, lê o token da variável de ambiente AZION_TOKEN em vez disso.

Para saber como os pacotes da Azion Lib resolvem o token e a configuração de debug, consulte Como a Azion Lib funciona.

createClient

Cria o cliente. createClient também é o export padrão do pacote azion.

TypeScript
01function createClient(config?: {
02 token?: string;
03 options?: AzionClientOptions;
04}): AzionClient;
ParâmetroTipoObrigatórioDescrição
tokenstringNãoO seu personal token da Azion.
optionsAzionClientOptionsNãoOpções da requisição. O tipo aceita debug somente dentro de options: um campo debug no nível superior é ignorado, e o TypeScript o recusa.

Retorna um AzionClient, com uma propriedade por módulo. Cada propriedade é o cliente desse módulo, e os métodos dela retornam o envelope de resposta que a página do módulo documenta.

Este exemplo cria um cliente e, pelo módulo sql dele, um banco de dados SQL:

JavaScript
01import { createClient } from 'azion';
02
03// Instantiate the client
04const client = createClient({ token: process.env.AZION_TOKEN, options: { debug: false } });
05
06// Access the SQL module and create a Database
07const { data: newDatabase, error } = await client.sql.createDatabase('my-database');
08if (newDatabase) {
09 console.log(`Database created with ID: ${newDatabase.id}`);
10} else {
11 console.error('Failed to create database', error);
12}

Saída:

Database created with ID: 1866

Em TypeScript, importe AzionClient da raiz azion e os tipos do módulo do subcaminho do módulo. Este exemplo lê o banco de dados que a chamada anterior criou:

TypeScript
01import { createClient } from 'azion';
02import type { AzionClient } from 'azion';
03import type { AzionDatabaseResponse, AzionDatabase } from 'azion/sql';
04
05// Instantiate the client
06const client: AzionClient = createClient({ token: process.env.AZION_TOKEN, options: { debug: false } });
07
08// Access the SQL module and read a Database
09const { data: database, error }: AzionDatabaseResponse<AzionDatabase> = await client.sql.getDatabase('my-database');
10if (database) {
11 console.log(`Database ${database.name} has ID ${database.id} (${database.status})`);
12} else {
13 console.error('Failed to get database', error);
14}

Saída:

Database my-database has ID 1866 (created)

Módulos

Um AzionClient contém exatamente seis propriedades, uma por módulo. Cada propriedade aceita as mesmas chamadas que o cliente criado pelo pacote do próprio módulo, e cada página de módulo documenta essas chamadas e o envelope de resposta delas.

PropriedadeTipoO que acessaPágina do módulo
storageAzionStorageClientBuckets do Object Storage e os objetos deles, pelos métodos que cada bucket traz.Storage
sqlAzionSQLClientBancos de dados SQL: criar, listar, ler e excluir. Um banco de dados que ele retorna traz os métodos query e execute.SQL
purgeAzionPurgeClientPurges de cache por URL, cache key ou wildcard.Purge
domainsAzionDomainsClientDomains: criar, listar, ler, atualizar e excluir. Chama a Azion API v3.Domains
applicationsAzionApplicationsClientApplications: criar, listar, ler, atualizar e excluir. Chama a Azion API v3.Applications
aiAzionAIClientChat completions, com chat e streamChat.Cliente de AI

Clientes de módulo e funções independentes

O cliente agregado é uma de três formas de chamar um módulo. Cada módulo também tem o próprio cliente interno, que o pacote dele cria com o próprio createClient, e cada função de módulo pode ser chamada sozinha, sem nenhum cliente. Um cliente de módulo recebe o token no campo token, como o cliente agregado. Uma função independente lê o token da variável de ambiente AZION_TOKEN, por exemplo de um arquivo .env.

Os módulos Storage e SQL têm pacotes próprios, @aziontech/storage e @aziontech/sql. Instale-os:

npm install @aziontech/storage @aziontech/sql

Este exemplo cria um cliente do módulo Storage a partir de @aziontech/storage e cria um bucket com ele:

TypeScript
01import { createClient } from '@aziontech/storage';
02import type { AzionStorageClient, AzionStorageResponse, AzionBucket } from '@aziontech/storage';
03
04// Create a client for the Storage module
05const client: AzionStorageClient = createClient({ token: process.env.AZION_TOKEN, options: { debug: false } });
06
07const { data, error }: AzionStorageResponse<AzionBucket> = await client.createBucket({
08 name: 'my-bucket',
09 workloads_access: 'read_only',
10});
11
12if (data) {
13 console.log(`Bucket created with name: ${data.name}`);
14} else {
15 console.error('Failed to create bucket', error);
16}

Saída:

Bucket created with name: my-bucket

Este exemplo chama createDatabase de @aziontech/sql sem cliente. O token vem de AZION_TOKEN, e o segundo argumento traz as opções da requisição:

JavaScript
01import { createDatabase } from '@aziontech/sql';
02
03// Call the function createDatabase directly from its package
04const { data, error } = await createDatabase('my-new-database', { debug: false });
05if (data) {
06 console.log(`Database created with ID: ${data.id}`);
07} else {
08 console.error('Failed to create database', error);
09}

Saída:

Database created with ID: 1867

Use o cliente agregado para acessar vários módulos a partir de um único objeto. Chame uma função independente quando você configura o token e as opções por variáveis de ambiente e quer apenas a função que chama.

Tipos

A raiz azion exporta os tipos AzionClient e AzionClientConfig. Importe-os com import type. A raiz também exporta defineConfig, processConfig e convertJsonConfigToObject, que a página Config documenta.

AzionClient

O cliente que createClient retorna. Para saber o que cada propriedade acessa, consulte Módulos.

PropriedadeTipoObrigatórioDescrição
storageAzionStorageClientSimO cliente do módulo Storage.
sqlAzionSQLClientSimO cliente do módulo SQL.
purgeAzionPurgeClientSimO cliente do módulo Purge.
domainsAzionDomainsClientSimO cliente do módulo Domains.
applicationsAzionApplicationsClientSimO cliente do módulo Applications.
aiAzionAIClientSimO cliente do módulo AI.

AzionClientConfig

O objeto que createClient recebe.

PropriedadeTipoObrigatórioDescrição
tokenstringNãoO seu personal token da Azion.
optionsAzionClientOptionsNãoOpções da requisição.

AzionClientOptions

O tipo das opções de requisição de AzionClientConfig. A raiz azion não o exporta: o cliente o declara a partir de azion/sql, então importe-o de lá quando precisar dele.

TypeScript
01type AzionClientOptions = {
02 debug?: boolean;
03 force?: boolean;
04 env?: AzionEnvironment;
05 external?: boolean;
06};
PropriedadeTipoObrigatórioDescrição
debugbooleanNãoAtiva o modo de debug.
forcebooleanNãoForça a operação, mesmo quando ela pode destruir dados.
envAzionEnvironmentNãoO ambiente para onde as chamadas vão: 'development', 'staging' ou 'production'.
externalbooleanNãoForça o uso da REST API em vez da API integrada ao runtime.

Recursos relacionados

Azion Lib

As bibliotecas que a Azion Lib oferece e o pacote que contém cada uma.

Como a Azion Lib funciona

Como os pacotes resolvem o token e as opções, e onde as funções deles rodam.

Storage

Todas as funções de bucket e de objeto que o cliente do módulo storage expõe.

SQL

Todas as funções de banco de dados e de query que o cliente do módulo sql expõe.