rmapi-js
    Preparing search index...

    Interface RemarkableOptions

    options for a remarkable instance

    interface RemarkableOptions {
        authHost?: string;
        cache?: string;
        maxCacheSize?: number;
        rawHost?: string;
        syncHost?: string;
        uploadHost?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authHost? cache? maxCacheSize? rawHost? syncHost? uploadHost?

    Properties

    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.

    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
    rawHost?: string

    the url for making requests using the low-level api

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

    the url for making synchronization requests

    "https://web.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