Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseQAPersistenceOptions

    Options for the useQAPersistence hook.

    interface UseQAPersistenceOptions {
        autoSaveInterval?: number;
        client: unknown;
        enabled: boolean;
        fileLocation?: string;
        fileName?: string;
        initialFileId?: string;
        onSave?: (fileId: string) => void;
        onSaveError?: (error: Error) => void;
        questionsRef?: RefObject<Question[]>;
        roomName?: string;
        userId: string;
    }
    Index

    Properties

    autoSaveInterval? client enabled fileLocation? fileName? initialFileId? onSave? onSaveError? questionsRef? roomName? userId

    Properties

    autoSaveInterval?: number

    Auto-save interval in milliseconds (default: 3000)

    client: unknown

    Hiyve client instance

    enabled: boolean

    Whether persistence is enabled

    fileLocation?: string

    File storage location (default: '/Questions')

    fileName?: string

    Custom file name (without timestamping) to use when creating the saved session file. The JSON extension is appended automatically if missing. When omitted, falls back to <sanitized-roomName>_questions_<timestamp>.json.

    initialFileId?: string

    Initial file ID for resuming saves to existing file

    onSave?: (fileId: string) => void

    Callback after successful save

    onSaveError?: (error: Error) => void

    Callback on save error

    questionsRef?: RefObject<Question[]>

    Ref to current questions array (updated by parent component)

    roomName?: string

    Room name for generating session names

    userId: string

    Current user ID

    Settings

    Member Visibility

    On This Page

    Properties