rmapi-js
    Preparing search index...

    Interface RemarkableOptions

    options for a remarkable instance

    interface RemarkableOptions {
        authHost?: string;
        cache?: string;
        maxCachedBytes?: number;
        maxCacheSize?: number;
        maxGenerationRetries?: number;
        maxTransientRetries?: number;
        rawHost?: string;
        uploadHost?: string;
    }

    Hierarchy (View Summary)

    Index
    authHost? cache? maxCachedBytes? maxCacheSize? maxGenerationRetries? maxTransientRetries? rawHost? uploadHost?
    authHost?: string

    the url for making authorization requests

    "https://webapp-prod.cloud.remarkable.engineering"
    cache?: string

    an initial cache value

    Generated from calling dumpCache on a previous instance.

    maxCachedBytes?: number

    the largest stored file to keep the contents of, in bytes

    Anything larger is fetched normally but only its existence is recorded, so one big pdf can't evict everything else. Set to 0 to cache nothing but existence, or Infinity to keep whatever is read.

    1048576
    maxCacheSize?: number

    the maximum size of the cache, in bytes of cached content plus key length

    The total memory usage of the cache will be somewhat larger than this, since it counts only the stored data.

    Infinity
    maxGenerationRetries?: number

    how many times to retry updating the root hash after a generation conflict

    High-level mutators re-fetch the latest root and re-apply their change on a GenerationError up to this many times. Because the document id and uploaded blobs are stable across attempts, retries reuse the cache and don't orphan blobs. Set to 0 to surface the error immediately, matching the previous behavior.

    10
    maxTransientRetries?: number

    how many times to retry a request after a transient network or 5xx error

    Applies to every request; generation conflicts are not counted here.

    3
    rawHost?: string

    the url for making requests using the low-level api

    "https://eu.tectonic.remarkable.com"
    uploadHost?: string

    the base url for making upload requests

    uploads now go to the same server as everything else, so this will be removed and rawHost will cover both. Point rawHost at the backend you want instead.

    "https://internal.cloud.remarkable.com"

    Settings
    Member Visibility

    On This Page
    Properties