getDescription( )

Gets the site description.

Description

The getDescription() function returns a Promise that resolves to the site's description information.

The retrieved description is the description that has been entered in the General Info section of your site's Dashboard.

Syntax

function getDescription(): Promise<string>

getDescription Parameters

This function does not take any parameters.

Returns

Fulfilled - An object containing the site description. Rejected - Error message.

Return Type:

Promise<string>

Was this helpful?

Get the site description

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import wixSiteBackend from 'wix-site-backend';
3
4export const getDescription = webMethod(Permissions.Anyone, () => {
5  return wixSiteBackend.generalInfo.getDescription(); // "Description text."
6});