#
initializeFireflyForStorybook
Create a runtime instance tailored for Storybook and optionally register local modules.
#
Reference
const runtime = initializeFireflyForStorybook(options?: { localModules?, environmentVariables?, featureFlags?, launchDarklyClient?, loggers? })
#
Parameters
options: An optional object literal of options:localModules: An optional array ofModuleRegisterFunction.environmentVariables: An optional object of environment variables.featureFlags: An optional Map instance of feature flags.launchDarklyClient: An optional LaunchDarkly client to override the default client.loggers: An optional array of logger instances.
#
Returns
A StorybookRuntime instance.
#
Usage
#
Initialize with local modules
import { initializeFireflyForStorybook } from "@squide/firefly-rsbuild-storybook";
const runtime = initializeFireflyForStorybook({
localModules: [...]
});
#
Initialize with environment variables
import { initializeFireflyForStorybook } from "@squide/firefly-rsbuild-storybook";
const runtime = initializeFireflyForStorybook({
environmentVariables: {
"foo": "bar"
}
});
#
Initialize with feature flags
import { initializeFireflyForStorybook } from "@squide/firefly-rsbuild-storybook";
// This syntax with the nested arrays and "as const" is super important to get type safety when
// using the "withFeatureFlagsOverrideDecorator" decorator.
const featureFlags = new Map([
["show-characters", true]
] as const);
const runtime = initializeFireflyForStorybook({
featureFlags
});
#
Initialize with a LaunchDarkly client
import { initializeFireflyForStorybook } from "@squide/firefly-rsbuild-storybook";
import { InMemoryLaunchDarklyClient } from "@squide/firefly";
// This syntax with the nested arrays and "as const" is super important to get type safety when
// using the "withFeatureFlagsOverrideDecorator" decorator.
const featureFlags = new Map([
["show-characters", true]
] as const);
const launchDarklyClient = new InMemoryLaunchDarklyClient(featureFlags);
const runtime = initializeFireflyForStorybook({
launchDarklyClient
});