Preset unenv

Preset de bundler da Azion Lib, do pacote @aziontech/unenv-preset, que mapeia globais e módulos do Node.js para polyfills do Azion Runtime.

Última atualização

Ver como Markdown Configurar agente

O pacote @aziontech/unenv-preset é o preset da Azion Lib para o unenv: um objeto de configuração que lista os globais, os módulos e os polyfills do Node.js que um build para o Azion Runtime substitui. O preset é aplicado pelo Azion Bundler, que a Azion CLI executa para fazer o build de um projeto. O pacote não tem funções para chamar: uma function acessa os polyfills ao importar módulos node:*, como node:fs e node:crypto.

Instale o pacote:

npm install @aziontech/unenv-preset

O exemplo do preset nesta página é um módulo ES em JavaScript que roda no Node.js. Os exemplos de function rodam dentro de uma function servida localmente com o azion dev. Para saber o que o node:fs retorna em uma function após o deploy, consulte node

.

Objeto do preset

O export padrão de @aziontech/unenv-preset é o objeto do preset, { inject, alias, external, polyfill }. O pacote não tem exports nomeados, então import { preset } from '@aziontech/unenv-preset' retorna undefined. Importe o objeto como export padrão:

JavaScript
01import preset from '@aziontech/unenv-preset';
02
03// The package has a default export only: { inject, alias, external, polyfill }
04console.log('keys:', Object.keys(preset));
05console.log('inject:', Object.keys(preset.inject));
06console.log('alias:', Object.keys(preset.alias));
07console.log('external:', preset.external);
08console.log('polyfill:', preset.polyfill);

Saída:

Texto
01keys: [ 'inject', 'alias', 'external', 'polyfill' ]
02inject: [
03 '__dirname',
04 '__filename',
05 'import.meta.url',
06 'process',
07 'performance',
08 'setInterval',
09 'clearInterval',
10 'console',
11 'asyncStorage',
12 'dateToString'
13]
14alias: [
15 '@aziontech/utils',
16 '@aziontech/utils/edge',
17 '@aziontech/utils/node',
18 'fetch-to-node',
19 'accepts',
20 'assert',
21 'buffer',
22 'https',
23 'module',
24 'string_decoder',
25 'timers',
26 'util',
27 'zlib'
28]
29external: [
30 'node:async_hooks',
31 'node:fs/promises',
32 'node:stream',
33 'node:crypto'
34]
35polyfill: [
36 'aziondev:async_hooks:/async-hooks/async-hooks.polyfills.js',
37 'aziondev:fs:/fs/fs.polyfills.js',
38 'aziondev:fs/promises:/fs/promises/promises.polyfills.js',
39 'aziondev:stream:/stream/stream.polyfills.js',
40 'aziondev:crypto:/crypto/crypto.polyfills.js',
41 'azionprd:fs:/fs.js'
42]

O objeto tem quatro propriedades:

PropriedadeTipoDescrição
injectobjectOs globais que o build injeta, cada chave mapeada para uma string. Para a lista, consulte Polyfills globais.
aliasobjectOs nomes de módulo que o build mapeia para um substituto, cada chave mapeada para uma string: @aziontech/utils, @aziontech/utils/edge, @aziontech/utils/node, fetch-to-node, accepts, assert, buffer, https, module, string_decoder, timers, util e zlib.
externalstring[]Quatro nomes de módulo: node:async_hooks, node:fs/promises, node:stream e node:crypto.
polyfillstring[]As entradas de polyfill. As entradas que começam com aziondev: atendem builds de desenvolvimento e cobrem async_hooks, fs, fs/promises, stream e crypto. A única entrada azionprd: atende builds de produção e cobre fs.

O build aplica esse objeto por você, então um projeto não o passa para o unenv manualmente. O preset unenv não é o campo preset de build no azion.config.js, que nomeia o preset de framework ou de linguagem de um projeto.

Polyfills globais

A propriedade inject do preset unenv lista os globais do Node.js que o build adiciona a uma function. Uma function usa esses globais como faria no Node.js, sem importar nada.

GlobalDescrição
__dirnameO nome do diretório atual.
__filenameO nome do arquivo atual.
processInformações do processo e o ambiente, incluindo as variáveis de ambiente.
performanceMedição de tempo de performance.

O preset também injeta import.meta.url, setInterval, clearInterval, console, asyncStorage e dateToString.

Módulos do Node.js em uma function

Uma function acessa os polyfills do preset unenv pelos nomes de módulo do Node.js. Importe node:fs ou node:crypto no código da function, e o build coloca o polyfill no lugar quando build.polyfills é true no azion.config.js. O template JavaScript que o azion init cria define polyfills como true.

Importe o módulo do Node.js, nunca um arquivo do pacote. Os arquivos de polyfill de @aziontech/unenv-preset não podem ser importados no Node.js nem em uma function, e o pacote não tem arquivo de polyfill de crypto. As mensagens que cada tentativa retorna estão em Erros.

As chamadas de node:fs leem os arquivos que build.memoryFS incorpora ao build. Um arquivo é lido pelo caminho relativo a removePathPrefix. Os exemplos de node:fs desta página usam um projeto cujo azion.config.js define build.memoryFS como { injectionDirs: ['./data'], removePathPrefix: './data' }. A pasta data/ desse projeto contém hello.txt, index.html, about/index.html e docs/readme.txt, então data/hello.txt é lido como /hello.txt.

No azion dev, o node:fs lê os arquivos incorporados da pasta .edge/storage/ do projeto. O node:fs local não tem writeFileSync, mkdirSync nem readSync.

createHash e randomUUID

As funções createHash e randomUUID vêm de node:crypto. createHash retorna um objeto de hash para um algoritmo, como sha256, e randomUUID retorna um UUID aleatório. Para o módulo completo, consulte node

.

Esta function gera o hash de uma string e gera um UUID:

JavaScript
01import { createHash, randomUUID } from 'node:crypto';
02
03export default {
04 async fetch() {
05 // Create a hash
06 const hash = createHash('sha256');
07 hash.update('some data');
08 const digest = hash.digest('hex');
09
10 // Generate a UUID
11 const uuid = randomUUID();
12
13 return new Response(`sha256=${digest}\nuuid=${uuid}\n`);
14 },
15};

Servida localmente com azion dev, a function retorna:

Texto
01$ curl http://localhost:3333/x
02HTTP/1.1 200 OK
03content-type: text/plain;charset=UTF-8
04
05sha256=1307990e6ba5ca145eb35e99182a9bec46531bc54ddf656a602c780fa0240dee
06uuid=e2ebf3ce-e7e9-4393-855c-ccdd93ea26f3

readFileSync

A função readFileSync de node:fs lê o conteúdo completo de um arquivo que build.memoryFS incorpora ao build.

ParâmetroTipoObrigatórioDescrição
pathstringSimO caminho do arquivo.
options—NãoOpções para a leitura, como a codificação utf8.

Retorna o conteúdo do arquivo como uma string ou um Buffer. Com a codificação utf8, o conteúdo é uma string.

Esta function retorna o conteúdo de /hello.txt, o arquivo data/hello.txt do projeto:

JavaScript
01import { readFileSync } from 'node:fs';
02
03export default {
04 async fetch() {
05 // Read a file embedded with build.memoryFS (data/hello.txt is served as /hello.txt)
06 const content = readFileSync('/hello.txt', 'utf8');
07 return new Response(content);
08 },
09};

Servida localmente com azion dev, a function retorna:

Texto
01$ curl http://localhost:3333/x
02HTTP/1.1 200 OK
03content-type: text/plain;charset=UTF-8
04
05Hello from memoryFS

readdirSync

A função readdirSync de node:fs lista o conteúdo de um diretório que build.memoryFS incorpora ao build.

ParâmetroTipoObrigatórioDescrição
pathstringSimO caminho do diretório.
options—NãoOpções para a listagem.

Retorna um string[] com os nomes dos arquivos e diretórios do diretório.

Esta function lista o diretório raiz e o diretório /docs:

JavaScript
01import { readdirSync } from 'node:fs';
02
03export default {
04 async fetch() {
05 // List directory contents
06 const files = readdirSync('/');
07 const docs = readdirSync('/docs');
08 return Response.json({ files, docs });
09 },
10};

Servida localmente com azion dev, a function retorna:

Texto
01$ curl http://localhost:3333/x
02HTTP/1.1 200 OK
03content-type: application/json
04
05{"files":["about","docs","hello.txt","index.html"],"docs":["readme.txt"]}

statSync e existsSync

A função existsSync de node:fs verifica se um caminho existe nos arquivos que build.memoryFS incorpora.

ParâmetroTipoObrigatórioDescrição
pathstringSimO caminho a verificar.

Retorna true quando o caminho existe e false quando não existe.

A função statSync de node:fs retorna as estatísticas de um arquivo ou de um diretório.

ParâmetroTipoObrigatórioDescrição
pathstringSimO caminho do arquivo ou do diretório.
options—NãoOpções para a chamada.

Retorna um objeto fs.Stats, com size, isFile() e isDirectory().

Esta function verifica /hello.txt, lê as estatísticas dele e verifica um caminho que o build não incorporou:

JavaScript
01import { statSync, existsSync } from 'node:fs';
02
03export default {
04 async fetch() {
05 const lines = [];
06 // Check if file exists
07 if (existsSync('/hello.txt')) {
08 // Get file stats
09 const stats = statSync('/hello.txt');
10 lines.push(`File size: ${stats.size}`);
11 lines.push(`Is directory: ${stats.isDirectory()}`);
12 lines.push(`Is file: ${stats.isFile()}`);
13 }
14 lines.push(`existsSync('/missing.txt'): ${existsSync('/missing.txt')}`);
15 return new Response(lines.join('\n') + '\n');
16 },
17};

Servida localmente com azion dev, a function retorna:

Texto
01$ curl http://localhost:3333/x
02HTTP/1.1 200 OK
03content-type: text/plain;charset=UTF-8
04
05File size: 20
06Is directory: false
07Is file: true
08existsSync('/missing.txt'): false

openSync e closeSync

A função openSync de node:fs abre um arquivo.

ParâmetroTipoObrigatórioDescrição
pathstringSimO caminho do arquivo.
flagsstringSimO modo de abertura, como 'r' ou 'w'.
mode—NãoO modo do arquivo.

Retorna o descritor de arquivo, um number.

A função closeSync de node:fs fecha um descritor de arquivo.

ParâmetroTipoObrigatórioDescrição
fdnumberSimO descritor de arquivo a fechar.

Esta function abre /hello.txt e fecha o descritor de arquivo dele:

JavaScript
01import { openSync, closeSync } from 'node:fs';
02
03export default {
04 async fetch() {
05 // Open file and get file descriptor
06 const fd = openSync('/hello.txt', 'r');
07 // Close file descriptor
08 closeSync(fd);
09 return new Response(`opened and closed fd ${fd}\n`);
10 },
11};

Servida localmente com azion dev, a function retorna:

Texto
01$ curl http://localhost:3333/x
02HTTP/1.1 200 OK
03content-type: text/plain;charset=UTF-8
04
05opened and closed fd 17

No azion dev, o descritor de arquivo é um que o sistema operacional atribui.

Erros

Estas mensagens aparecem quando o código importa um arquivo de @aziontech/unenv-preset ou chama uma função de node:fs que o runtime local não tem.

MensagemCausaO que fazer
ERR_MODULE_NOT_FOUND Cannot find module '…/node_modules/@aziontech/unenv-preset/src/polyfills/node/crypto'O código importa @aziontech/unenv-preset/polyfills/node/crypto. O pacote não tem arquivo de polyfill de crypto.Importe de node:crypto em uma function, como em createHash e randomUUID.
TypeError: Cannot read properties of undefined (reading '__FILES__')Um script Node.js importa @aziontech/unenv-preset/polyfills/node/fs.js. O arquivo lê os arquivos incorporados de um build, que um script Node.js não tem.Importe de node:fs em uma function cujo build a Azion CLI faz.
ReferenceError: SRC_NODE_FS is not definedUma function importa @aziontech/unenv-preset/polyfills/node/fs.js, e o azion dev para na inicialização do servidor.Importe de node:fs, como em readFileSync.
TypeError: (void 0) is not a functionUma function chama writeFileSync, mkdirSync ou readSync de node:fs no azion dev. O build avisa que o import will always be undefined because there is no matching export in "internal-env-dev:fs".Leia arquivos com as chamadas desta página.

Recursos relacionados

Como a Azion Lib funciona

Onde cada módulo da Azion Lib roda, no Node.js ou em uma function, e o que muda entre os dois.

Use APIs do Node.js com polyfills

Crie um projeto de function, importe uma API do Node.js e execute-a localmente e após o deploy.

APIs do Node.js

Os módulos do Node.js que o Azion Runtime resolve, com o comportamento de cada um.

azion.config.js

As configurações build.polyfills e build.memoryFS, que definem quais polyfills e arquivos um build carrega.