AboutSupportDeveloper GuideVersion 22.3.24

Function deregister

API function to deregister a Storefront provider.

Throws

an error if the provider is not currently registered.

Example

import { Storefront, type StorefrontProvider } from "@openfin/workspace";

const myStorefrontProvider: StorefrontProvider = {
     id: "my-storefront-id"
     title: "My StoreFrontProvider"
     icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
     getApps: () => {...},
     getNavigation: () => {...},
     getLandingPage: () => {...},
     getFooter: () => {...},
     launchApp: () => {...}
};

await Storefront.register(myStorefrontProvider);

await Storefront.deregister("my-storefront-id");
  • deregister(providerId): Promise<void>

  • Parameters

    • providerId: string

      the id of the provider to deregister.

    Returns Promise<void>

    promise that resolves once the provider is deregistered.

Settings