Defines a backend function that can be called from the frontend.
The webMethod() function is a wrapper used to export functions from backend code that can be called from the frontend.
The permissions parameter is used to define which site visitors have permission to call the function produced by webMethod(). Import the Permissions enum from @wix/code/web-methods to define the permissions.
Caution: Be careful when selecting a permission, as exposing a function with the wrong permissions can create security risks.
Web methods must be defined in a file with a .web.ts extension.
| Name | Type | Description |
|---|---|---|
permissions | Permissions | Permissions needed to call the function in frontend code. Permission options: - 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. |
webFunction | Function | Function to wrap with webMethod(). This function must return serializable results. This function can be asynchronous. Note: You may need to elevate the permissions of API calls made in this function. |
Function
The function specified in the webMethod() call, wrapped with the webMethod() function. This wrapped function always returns a promise that resolves to the response from the original function you provided.
Note: The passed function can be asynchronous, and must return serializable results.