Function deregister

API function to deregister a Home provider.

Remarks

A Workspace Platform must be initialized, and the Home provider must be registered for this function to take effect.

Throws

an error if the provider is not registered.

Example: Deregister a Home provider.

import { Home } from '@openfin/workspace';

await Home.deregister('my-home-provider');

deregister(providerId): Promise<void>
Parameters
- providerId: string
  the Home provider ID.
Returns Promise<void>
a promise that resolves once the Home provider is successfully deregistered.