Interface

Namespaces

Methods

cleanup

static

cleanup()

Complete clean up tasks.

makeChange

static

makeChange(before, after) returns Object

Make a Change object to be used as test data for Firestore and Realtime Database onWrite and onUpdate functions.

Parameter

before

Object

Snapshot before the write or update.

Value must not be null.

after

Object

Snapshot after the write or update.

Value must not be null.

Returns

non-null Object A Change object for testing.

mockConfig

static

mockConfig(config)

Mock values returned by functions.config().

Parameter

config

Object

Key value pairs representing the config to mock.

Value must not be null.

wrap

static

wrap(cloudFunction) returns test.WrappedFunction

Takes a function to be tested, and returns a WrappedFunction which can be called in test code.

Parameter

cloudFunction

Object

A CloudFunction is both an object that exports its trigger definitions at __trigger and can be called as a function using the JavaScript API for Google Cloud Functions.

Value must not be null.

Returns

non-null test.WrappedFunction 

WrappedFunction

static

WrappedFunction(data, options)

A function type that can be called with test data and optional override values for the event context. It will subsequently invoke the function it wraps with the provided test data and a generated event context.

Parameter

data

any type

The test data.

Value must not be null.

options

Object

Override values for event context as an EventContextOptions object.

Value may be null.