how to use firebase cloud function pubsub.schedule?

Question

Today, there is new feature of Cloud Functions for Firebase which is running functions on a schedule. So I tried to test the sample code.

index.js file

exports.scheduledFunction = functions.pubsub.schedule(‘every 5 minutes’).onRun((context) => {
  console.log(‘This will be run every 5 minutes!’);
});

But when I tried to deploy this, I got the following error message:

Error: Error occurred while parsing your function triggers.

TypeError: functions.pubsub.schedule is not a function

My firebase tools version is 6.7 (updated today)

What is the solution?

I checked the example git code in here (https://github.com/firebase/functions-samples/blob/master/delete-unused-accounts-cron/functions/index.js)

But it also cause the same error:

functions.pubsub.schedule is not a function

Can anyone help me with this problem?

const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp();

exports.scheduledFunction = functions.pubsub.schedule('every 5 minutes').onRun((context) => {
   console.log('This will be run every 5 minutes!');
});

score 17 · Accepted Answer · answered Apr 19 '19 at 06:23

17

The announcement blog post points out that the version of the firebase-functions module also needs to be minimum 2.3.0. Run npm install firebase-functions@latest in your functions folder to update it, then build and deploy again.

answered Apr 19 '19 at 06:23

Doug Stevenson

297,357
32
422
441

This one fixed the issue for me. If it fixed your issue too @SssSteve, this should be the accepted answer. – SaloGala May 03 '19 at 19:55
This worked for me. Installed in the functions root folder. – LukeVenter Jul 09 '19 at 09:21
I got this error functions[scheduledFunction]: function ignored because the pubsub.googleapis.com emulator does not exist or is not running. – HMagdy Sep 23 '19 at 21:08
I am using "firebase-functions": "^3.3.0" , still i am having this issue – Amaldev ps Mar 31 '20 at 08:00

score 3 · Answer 2 · answered May 31 '19 at 02:56

3

Here's the documentation https://firebase.google.com/docs/functions/schedule-functions

export const scheduledFunction = functions.pubsub.schedule('every 5 minutes')
.timeZone('Asia/Jakarta')
.onRun((context) => {
    console.log('This will be run every 5 minutes!');
});

And you can set the timeZone as additional

answered May 31 '19 at 02:56

NormsDev

57
1

Not relating at all – Lạng Hoàng Mar 28 '20 at 09:35

score -1 · Answer 3 · answered May 02 '19 at 14:01

-1

I had the same issue.

I had to update my firebase-tools to version ^6.7.2. I have also updated firebase-functions but that alone did not do the job. So I would update all firebase dependencies (firebase-tools/admin/functions).

answered May 02 '19 at 14:01

Jürgen Brandstetter

7,066
3
35
30

how to use firebase cloud function pubsub.schedule?

index.js file

3 Answers3