Type alias AppConfiguration

AppConfiguration: {
    app?: LocalAppConfiguration;
    baseFilePath?: string;
    baseUrl?: string;
    fetch?: AnyFetch;
    id: string;
    metadata?: Metadata;
    multiplexSessions?: boolean;
    timeout?: number;
}

This describes the options used to create a Realm App instance.

Type declaration

  • Optional app?: LocalAppConfiguration

    This describes the local app, sent to the server when a user authenticates. Specifying this will enable the server to respond differently to specific versions of specific apps.

    Since

    v10.0.0

  • Optional baseFilePath?: string

    Specify where synced Realms and metadata is stored. If not specified, the current work directory is used.

    Since

    v11.7.0

  • Optional baseUrl?: string

    An optional URL to use as a prefix when sending requests to the Atlas App Services server.

    Since

    v10.0.0

  • Optional fetch?: AnyFetch

    Overrides the fetch function used to perform network requests.

  • id: string

    The Realm App ID

    Since

    v10.0.0

  • Optional metadata?: Metadata

    Specify how meta data should be stored.

    Since

    12.2.0

  • Optional multiplexSessions?: boolean

    Use the same underlying connection towards the server across multiple sync sessions. This uses less resources on the server and provides a small increase in speed when opening subsequent synced Realms.

    Default

    true
  • Optional timeout?: number

    The timeout for requests (in milliseconds)

    Since

    v10.0.0

Settings

Member Visibility

Theme

Generated using TypeDoc