getPackageConfig( )


Retrieves the value of a specific key in a package's config.json file.

The getPackageConfig() function returns a Promise that resolves to the value of a key in a package's config.json file.

When you build a Velo package, you can include a config.json file. Users of the package can edit this file and add personalized information such as settings preferences. The getPackageConfig() function allows you to access the contents of the config.json file in your package code.

Method Declaration
Copy
function getPackageConfig(key: string): Promise<any>;
Method Parameters
keystringRequired

The config.json key whose value you want to retrieve.

Returns
Return Type:Promise<any>
Retreive a user's ID number from a package's config.json file
JavaScript
import { getPackageConfig } from "wix-configs-backend"; // ... const userId = getPackageConfig("id");
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?