Administra dependencias

Las funciones pueden usar módulos de Node.js externos y datos locales. Las dependencias en Node.js se administran con npm y se expresan en un archivo de metadatos llamado package.json. Los entornos de ejecución de Node.js para Cloud Functions admiten la instalación mediante npm o yarn.

A fin de especificar una dependencia para tu función, agrégala a tu archivo package.json.

En este ejemplo, se incluye una dependencia en el archivo package.json:

{
  "dependencies": {
    "escape-html": "^1.0.3"
  }
}

Luego, la dependencia se importa en la función:

JavaScript

const escapeHtml = require('escape-html');

// Return a greeting with the input HTML-escaped.
exports.hello = functions.https.onRequest((req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
});

TypeScript

import * as escapeHtml from 'escape-html';

// Return a greeting with the input HTML-escaped.
export let hello = functions.https.onRequest((req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
}

Incluye módulos locales de Node.js como parte de tu paquete de implementación

También puedes incluir módulos locales de Node.js como parte de tu función. Para ello, declara tu módulo en package.json mediante el prefijo file:. En el siguiente ejemplo, mymodule hace referencia al nombre del módulo y mymoduledir es el directorio que contiene el módulo:

{
  "dependencies": {
    "mymodule": "file:mymoduledir"
  }
}

El código de este módulo local no debe estar en tu carpeta node_modules. Basta con almacenarlo en la raíz del directorio de tu función.

Instala módulos de Node.js localmente con npm

La manera más fácil de instalar un módulo de Node.js de forma local implica usar el comando npm install en la carpeta que contiene la Cloud Function. Por ejemplo, el siguiente comando agrega el módulo uuid:

npm install uuid

Esto combina dos pasos:

  1. Marca la versión más reciente del módulo como una dependencia en tu archivo package.json. Esto es muy importante: Cloud Functions solo instala módulos que están declarados en tu archivo package.json.
  2. Descarga el módulo en tu directorio node_modules. Esto te permite usar el módulo cuando realizas desarrollos locales.

Si no tienes npm instalado en tu computadora, descárgalo.

Pasos adicionales para TypeScript

TypeScript te ayuda mucho más cuando usas bibliotecas que tienen información sobre tipos. Esto permite que TypeScript detecte errores de sintaxis y que los editores te ofrezcan mejores sugerencias de autocompletado. Algunas bibliotecas, como firebase-admin y firebase-functions, se envían con las definiciones de TypeScript incluidas.

Muchas bibliotecas no proporcionan definiciones de TypeScript. El proyecto DefinitelyTyped proporciona definiciones con mantenimiento de la comunidad para las bibliotecas de nodos más populares. DefinitelyTyped publica estas definiciones con el mismo nombre del paquete NPM, pero dentro de la organización “@types”. Por ejemplo, a fin de instalar la información sobre tipos para la biblioteca uuid, puedes usar este comando:

npm install @types/uuid

Cuando estés más familiarizado con TypeScript, podrás combinar ambas instalaciones:

npm install uuid @types/uuid

Las dependencias de tipo deberían ser del mismo tipo que las de la biblioteca. Por ejemplo, no deberías guardar uuid como una dependencia normal y @types/uuid como una dependencia de desarrollo o de par.

Carga módulos Node.js

Utiliza la función require() de Node.js para cargar cualquier módulo de Node.js que hayas instalado. También puedes usar la función require() para importar archivos locales que implementes junto con tu función.

Si escribes funciones en TypeScript, usa la declaración import de la misma forma para cargar los módulos Node.js que tengas instalados.

Usa módulos privados

Para usar un módulo de npm privado, debes proporcionar credenciales (token de autenticación) para el registro de npm en un archivo .npmrc ubicado en el directorio de la función. En la documentación de npm, se explica cómo crear tokens personalizados de acceso de solo lectura. No recomendamos el uso del archivo .npmrc creado en el directorio de inicio porque contiene un token de lectura-escritura. No se necesitan permisos de escritura para la implementación. Además, podrían poner en riesgo la seguridad.

No incluyas el archivo .npmrc si no usas repositorios privados, ya que puede aumentar el tiempo de implementación de tus funciones.