@gobstones/gobstones-scripts
Version:
Scripts to abstract away build configuration of Gobstones Project's libraries and modules.
47 lines • 1.38 kB
TypeScript
/**
* This type represents the options that you can pass to the storybook start task.
*/
export interface TaskStorybookStartOptions {
/**
* The port on which to start storybook's server.
*/
port: number;
}
/**
* This type represents the options that you can pass to the storybook build task.
*/
export interface TaskStorybookBuildOptions {
/**
* The output directory of the build
*/
outDir: string;
}
/**
* The storybook object holds the different ways in you can run a
* task in storybook, either by running start or build.
*/
export declare const storybook: {
/**
* Returns the string for the bash command to run
* storybook.start with the project's configuration.
*
* @param options - The options applied when running storybook.
*
* @example storybook.start({ port: 3000 })
*
* @returns The bash command string.
*/
start: (options?: TaskStorybookStartOptions) => string;
/**
* Returns the string for the bash command to run
* storybook.build with default configuration.
*
* @param options - The options applied when running storybook.
*
* @example storybook.build({ outDir: './dist' })
*
* @returns The bash command string.
*/
build: (options: TaskStorybookBuildOptions) => string;
};
//# sourceMappingURL=storybook.d.ts.map