storycrawler/lib/browser/stories-browser.d.ts

Utilities to build Storybook crawling tools with Puppeteer

import { BaseBrowser, BaseBrowserOptions } from './base-browser';
import { Logger } from '../logger';
import { StorybookConnection } from '../storybook-connection';
/**
 *
 * Browser class to fetch all stories names.
 *
 **/
export declare class StoriesBrowser extends BaseBrowser {
    protected connection: StorybookConnection;
    protected opt: BaseBrowserOptions;
    protected logger: Logger;
    /**
     *
     * @param connection Connected connection to the target Storybook server
     * @param opt Options to launch browser
     * @param logger Logger instance
     *
     **/
    constructor(connection: StorybookConnection, opt?: BaseBrowserOptions, logger?: Logger);
    /**
     *
     * Fetches stories' id, kind and names
     *
     * @returns List of stories
     *
     * @remarks
     * This method automatically detects version of the Storybook.
     *
     **/
    getStories(): Promise<import("../story-types").V5Story[]>;
}