@roomy-chat/sdk
    Preparing search index...

    Type Alias StorageConfig

    A policy describing how to

    type StorageConfig = {
        manager: StorageManager;
        read?: boolean;
        write?: boolean;
        writeThrottle?: (write: () => void) => void;
    }
    Index

    Properties

    manager read? write? writeThrottle?

    Properties

    manager: StorageManager

    The storage manager to use.

    read?: boolean

    Whether this storage should be read from when loading documents. Defaults to true.

    write?: boolean

    Whether this storage should be written to when documents change. Defaults to true.

    writeThrottle?: (write: () => void) => void

    Custom throttle function that can be used to debounce or throttle writes to this storage. The function should call write() when it wants to actually trigger the pending write to storage.

    Settings

    Member Visibility

    On This Page

    Properties