@scalar/api-reference/dist/plugins/persistance-plugin.d.ts

Generate beautiful API references from OpenAPI documents

import type { WorkspacePlugin } from '@scalar/workspace-store/workspace-plugin';
/**
 * Plugin to persist workspace state changes with debounced writes.
 */
export declare const persistencePlugin: ({ debounceDelay, maxWait, prefix, persistAuth, }: {
    debounceDelay?: number;
    /** Maximum time in milliseconds to wait before forcing execution, even with continuous calls. */
    maxWait?: number;
    /**
     * Prefix to use for local storage keys.
     * This can be a string or a function returning a string.
     * For example, to persist data per document, use the document name as the prefix.
     */
    prefix?: string | (() => string);
    /**
     * Determines whether authentication details should be persisted.
     * Accepts a boolean or a function that returns a boolean.
     * Allows for conditional persistence logic, e.g., based on environment or user settings.
     */
    persistAuth?: boolean | (() => boolean);
}) => WorkspacePlugin;
//# sourceMappingURL=persistance-plugin.d.ts.map