effect-playwright
    Preparing search index...

    Interface Screencast

    0.5.0

    interface Screencast {
        hideActions: Effect<void, PlaywrightError>;
        hideOverlays: Effect<void, PlaywrightError>;
        showActions: (
            options?: {
                cursor?: "none" | "pointer";
                duration?: number;
                fontSize?: number;
                position?:
                    | "top-left"
                    | "top"
                    | "top-right"
                    | "bottom-left"
                    | "bottom"
                    | "bottom-right";
            },
        ) => Effect<void, PlaywrightError>;
        showChapter: (
            title: string,
            options?: { description?: string; duration?: number },
        ) => Effect<void, PlaywrightError>;
        showOverlay: (
            html: string,
            options?: { duration?: number },
        ) => Effect<void, PlaywrightError>;
        showOverlays: Effect<void, PlaywrightError>;
        start: (
            options?: {
                annotate?: {
                    duration?: number;
                    fontSize?: number;
                    position?:
                        | "top-left"
                        | "top"
                        | "top-right"
                        | "bottom-left"
                        | "bottom"
                        | "bottom-right";
                };
                onFrame?: (
                    frame: {
                        data: Buffer;
                        timestamp: number;
                        viewportHeight: number;
                        viewportWidth: number;
                    },
                ) => any;
                path?: string;
                quality?: number;
                size?: { height: number; width: number };
            },
        ) => Effect<void, PlaywrightError>;
        stop: Effect<void, PlaywrightError>;
    }
    Index
    hideActions: Effect<void, PlaywrightError>

    Hides action annotations.

    hideOverlays: Effect<void, PlaywrightError>

    Hides all overlays.

    showActions: (
        options?: {
            cursor?: "none" | "pointer";
            duration?: number;
            fontSize?: number;
            position?:
                | "top-left"
                | "top"
                | "top-right"
                | "bottom-left"
                | "bottom"
                | "bottom-right";
        },
    ) => Effect<void, PlaywrightError>

    Shows action annotations.

    showChapter: (
        title: string,
        options?: { description?: string; duration?: number },
    ) => Effect<void, PlaywrightError>

    Shows a chapter title.

    showOverlay: (
        html: string,
        options?: { duration?: number },
    ) => Effect<void, PlaywrightError>

    Shows a custom HTML overlay.

    showOverlays: Effect<void, PlaywrightError>

    Shows all overlays.

    start: (
        options?: {
            annotate?: {
                duration?: number;
                fontSize?: number;
                position?:
                    | "top-left"
                    | "top"
                    | "top-right"
                    | "bottom-left"
                    | "bottom"
                    | "bottom-right";
            };
            onFrame?: (
                frame: {
                    data: Buffer;
                    timestamp: number;
                    viewportHeight: number;
                    viewportWidth: number;
                },
            ) => any;
            path?: string;
            quality?: number;
            size?: { height: number; width: number };
        },
    ) => Effect<void, PlaywrightError>

    Starts recording the screencast.

    0.5.0

    stop: Effect<void, PlaywrightError>

    Stops recording the screencast.

    0.5.0