webMethod( )

Defines a backend function that can be called from the frontend.

Description

The webMethod() function is a wrapper used to export functions from backend code that can be called from the frontend. Use the function's first parameter to define the permissions needed to call the function in frontend code. You can import the Permissions enum from the wix-web-module module to define the permissions. The permission options are:

Permissions.Anyone: Any site visitor can call the function.
Permissions.Admin: Only site admins can call the function.
Permissions.SiteMember: Only site members can call the function.

Web methods must be defined in files with a .web.js extension.

Syntax

function webMethod(permissions: Permissions, function: Function): Promise<function()>

webMethod Parameters

NAME

TYPE

DESCRIPTION

permissions

Permissions

Permissions needed to call the function in frontend code.

function

Function

Function to export.

Returns

Return Type:

Promise<function()>

Was this helpful?

Export a backend function and use it in frontend code

Copy Code

1// Exporting a backend function from a '.web.js' file:
2import {Permissions, webMethod} from "wix-web-module";
3
4export const multiply = webMethod(Permissions.Anyone, (a,b) => a * b);
5
6// Using the function in frontend code:
7import {multiply} from "backend/multiply.web";
8
9$w.onReady(async function () {
10  multiply(5, 3).then((result) => {
11    console.log(result); // Logs 15
12  });
13});