Function Store
  • Home
  • Getting started
    • Introduction
    • Installing a function
    • Reconfiguring a function
    • Uninstalling a function
    • FAQs
  • Reference
    • Requirements
      • Assign Roles
        • User permissions
      • Link a Billing account to your project
      • Enable the APIs
    • Projects
      • How to add a project
      • How to set up a project
    • Functions
      • Benefits
      • Use cases
      • Authentication when installing
      • Runtime configuration
      • Deploying with a ZIP file
    • Policies
      • How to add a Policy
      • How to remove a Policy
    • Authentication
      • Users
      • Roles
      • Permissions
    • Secrets
      • Creating a Secret
      • Using a Secret
      • Changing the value for a Secret
      • Deactivating a Secret
  • developers
    • Overview
    • Getting Started
    • Set up
    • Workspaces
      • Create a workspace
      • Workspace boilerplate
      • Node engines
    • Writing Functions
      • Function Anatomy
      • Configuration file
      • Function Triggers
      • Environment Variables
        • Type "text"
        • Type "number"
        • Type "email"
        • Type "url"
        • Type "json"
        • Type "boolean"
        • Type "select"
        • Type "multiselect"
        • Type "firestoreDocumentPath"
        • Type "firestoreCollectionPath"
        • Type "color"
      • Documentation
    • Push/Update your functions in the cloud
    • Continuous Integration
    • Publish functions in the Marketplace
    • Emulators
      • Initialize emulators in your workspace
      • Environment variables
      • Starting emulators
      • Testing your functions in the emulator
      • Importing existing data into local emulators
        • Exporting data from Cloud Firestore to local emulator
        • Exporting user accounts from Firebase to local emulator
    • Visual Studio Code Extension
      • Installing the extension
      • Extension UI
      • Functions list
      • Creating and editing functions
      • Emulators
      • Extension settings
      • Troubleshooting
        • "Command not found" error when executing a command
  • Billing
    • Understanding Billing
  • Security
    • Security
  • Resources
    • Events and Triggers
    • Best Practices
      • How to log events in functions?
    • Document your Functions
    • Editorial guidelines
    • Our Processes
      • Use Cases Analysis
  • Use cases
    • Custom Stripe Checkout
Powered by GitBook
On this page
  • Example of a type "multiselect" environment variable definition
  • Example of how to consume the value of the environment variable within the function implementation
  • Properties of the type

Was this helpful?

  1. developers
  2. Writing Functions
  3. Environment Variables

Type "multiselect"

PreviousType "select"NextType "firestoreDocumentPath"

Last updated 3 years ago

Was this helpful?

If your function implementation needs to make multiple selections from a group of statics options, you can use environment variables of type multiselect in your implementation. Then our platform will ask consumers to enter their value during installation.‌

The type multiselect variables allow the consumers of a function to select multiple elements between a list of options, which you need to define using the options prop. This type is displayed in the installation UI form as a checkbox group element (see image below).

Example of a type "multiselect" environment variable definition

"env": [
    {
        "name": "PAYMENT_METHOD",
        "description": "The payment methods that the customer can use to make payments.",
        "required": true,
        "type": "multislect",
        "options": [
            "card",
            "cash",
            "invoice",
            "external"
        ],
        "default": [
            "cash",
            "invoice"
        ]
    }
]
‌

Example of how to consume the value of the environment variable within the function implementation

const myFunction = () => {
    const paymentMethod = JSON.parse(process.env.PAYMENT_METHOD)
    ...
};

module.exports = myFunction;

Properties of the type

property

type

required

default

description

name

string

yes

-

The name of the environment variable. This should be unique for each variable.

description

string

no

-

The description of the environment variable.

default

array

no

-

The default values for the variable.

required

bool

no

false

Specifies that a variable must be filled out before submitting.

options

array

yes

-

The options will define the env values for the select. Each option value should be unique inside the array.