Menangani dependensi

Untuk menentukan dependensi bagi fungsi Anda, tambahkan dependensi tersebut ke file package.json.

Dalam contoh ini, dependensi tercantum dalam file package.json:

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

Kemudian, dependensi tersebut akan diimpor dalam fungsi:

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')}!`);
});

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')}!`);
}

Menyertakan modul Node.js lokal

Anda juga dapat menyertakan modul Node.js lokal sebagai bagian dari fungsi Anda. Caranya, deklarasikan modul Anda di package.json menggunakan awalan file:. Dalam contoh berikut, mymodule merujuk ke nama modul Anda dan mymoduledir adalah direktori yang berisi modul Anda:

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

Kode untuk modul lokal ini tidak boleh disimpan di folder node_modules dalam direktori root fungsi Anda.

Langkah tambahan untuk TypeScript

TypeScript sangat membantu saat Anda menggunakan library yang memiliki informasi jenis. Dengan begitu, TypeScript dapat mendeteksi error sintaksis dan editor dapat memberikan saran pelengkapan otomatis yang lebih baik kepada Anda. Beberapa library, seperti firebase-admin dan firebase-functions, dilengkapi dengan definisi TypeScript.

Banyak library yang tidak menyediakan definisi TypeScript-nya sendiri. Project DefinitelyTyped memberikan definisi yang dikelola komunitas untuk library node yang paling populer. DefinitelyTyped memublikasikan definisi ini dengan nama paket NPM yang sama, tetapi berada dalam organisasi "@types". Misalnya, Anda dapat menginstal informasi jenis untuk library uuid dengan perintah berikut ini:

npm install @types/uuid

Jika sudah terbiasa menggunakan TypeScript, Anda dapat menggabungkan kedua penginstalan:

npm install uuid @types/uuid

Dependensi jenis harus sama dengan dependensi library. Misalnya, Anda tidak boleh menyimpan uuid sebagai dependensi normal dan @types/uuid sebagai dependensi dev atau dependensi peer.

Memuat modul Node.js

Gunakan fungsi require() Node.js untuk memuat modul Node.js mana pun yang telah diinstal. Anda juga dapat menggunakan fungsi require() untuk mengimpor file lokal yang di-deploy bersama fungsi Anda.

Menggunakan modul pribadi

Anda dapat menggunakan modul npm pribadi dengan menyediakan setelan untuk mengautentikasi dengan registry dalam file .npmrc di direktori fungsi.

Modul pribadi dari Artifact Registry

Package repository Node.js Artifact Registry dapat menghosting modul pribadi untuk fungsi Anda. Saat melakukan deployment ke Cloud Functions, proses build akan otomatis menghasilkan kredensial Artifact Registry untuk akun layanan Cloud Build. Anda hanya perlu mencantumkan repositori Artifact Registry di .npmrc tanpa membuat kredensial tambahan. Contoh:

@SCOPE:registry=REPOSITORY_URL
//REPOSITORY_URL:always-auth=true

Modul pribadi dari repositori lain

Dokumentasi npm menjelaskan cara membuat token akses hanya baca kustom. Sebaiknya jangan gunakan file .npmrc yang dibuat di direktori home karena file tersebut berisi token baca-tulis. Izin tulis tidak diperlukan selama deployment, dan dapat menimbulkan risiko keamanan.

Jangan menyertakan file .npmrc jika Anda tidak menggunakan repositori pribadi, karena dapat memperlama waktu deployment untuk fungsi Anda.

Format file

Jika Anda menggunakan file .npmrc untuk menetapkan token autentikasi kustom, file tersebut harus menyertakan baris yang ditampilkan di bawah. Ganti <YOUR_AUTH_TOKEN> dengan token autentikasi yang diberikan NPM.

//registry.npmjs.org/:_authToken=<YOUR_AUTH_TOKEN>