Registering Extensions

When an extension is created it's recommended to have the extension registered to ensure it's visible on FaxStore's staff panel and internally within the FaxStore application.

Registering an extension is universal over all created extensions and used the global faxstore variable to do this. By using the faxstore.registerExtension() function this can be done.

Required Parameters

Only a few parameters in the faxstore.registerExtension() function are required by FaxStore. These being:

name - string
__filename - this should be set as __filename where the second parameter is on the faxstore.registerExtension() function as per the below.

All other options are optional in the function. However, as many as possible are recommended.

Register Extension Examples

faxstore.registerExtension({
    name: 'My Extension',
    description: 'Here is a description of this extension',
    icon: 'https://weblutions.com/assets/logo.png',
    config: extConfig,
    version: '1.0.0',
    author: 'Weblutions',
    url: 'https://github.com/FAXES/faxstore-extensions',
    staffPage: {
        icon: 'fa-solid fa-grid',
        name: 'Extension Name',
        link: '/staff/myextension/settings'
    }
    pages: ['/staff/myextension', '/staff/myextension/settings']
}, __filename);