markdown.d.ts

import type { FeatureApi } from "./cypress";

/**
 * Parse markdown content string and create a feature from it.
 * The structure of markdown file is following:
 * # Feature title
 * Optional paragraph or multiple paragraphs of feature description, may contain links
 * 
 * ## Category
 * - list of requirements
 * 
 * @param {string} markdown String of markdown content
 */
export declare const parseMarkdownFeature: (markdown: string) => FeatureApi;

/**
 * Since it uses cy.readFile(), it can be executed only within cypress hooks like before().
 *
 * @param {string} path Path to markdown file from feature root
 */
export declare const createFeatureFromMarkdown: (path: string) => {
  // Cypress.Chainable<FeatureApi>
  then: (callback: (FeatureApi: FeatureApi) => void) => void;
};

/**
 * It immediately returns empty feature and creates a before() hook which reads markdown file.
 * Once markdown has been read, its content(title, description, structure) merged
 * with returned feature.
 *
 * This way we don't need to wait for a promise or wrap it into lifecycle hooks.
 *
 * @param {string} path Path to markdown file from feature root
 */
export declare const createFeatureFromMarkdownAsync: (path: string) => FeatureApi;