rmapi-js
    Preparing search index...

    Interface RemarkableSessionOptions

    options for constructing an api instance from a session token

    interface RemarkableSessionOptions {
        cache?: string;
        maxCacheSize?: number;
        maxGenerationRetries?: number;
        maxTransientRetries?: number;
        rawHost?: string;
        uploadHost?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cache? maxCacheSize? maxGenerationRetries? maxTransientRetries? rawHost? uploadHost?

    Properties

    cache?: string

    an initial cache value

    Generated from calling dumpCache on a previous instance.

    maxCacheSize?: number

    the maximum size of the cache in terms of total string length

    By the JavaScript specification there are two bytes per character, but the total memory usage of the cache will also be larger than just the size of the data stored.

    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

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

    Settings

    Member Visibility

    On This Page

    Properties