Type alias Configuration

Configuration: {
    debug?: boolean;
    debugging?: {
        injectIntoGlobalContext?: boolean;
    };
    fileSystem?: {
        loadImmediately?: boolean;
        version?: string;
    };
    namespace: string | AppInfo;
    permissions?: Permissions;
    userMessages?: UserMessages;
}

Type declaration

  • Optional debug?: boolean

    Enable debug mode.

    Default

    false

  • Optional debugging?: {
        injectIntoGlobalContext?: boolean;
    }

    Debugging settings.

    • Optional injectIntoGlobalContext?: boolean

      Should I add programs to the global context while in debugging mode?

      Default

      true

  • Optional fileSystem?: {
        loadImmediately?: boolean;
        version?: string;
    }

    File system settings.

    • Optional loadImmediately?: boolean

      Should I load the filesystem immediately?

      Default

      true

    • Optional version?: string

      Set the file system version.

      This will only affect new file systems created. Existing file systems (whether loaded from another device or loaded locally) continue using the same version. If you're looking to migrate an existing file system to a new file system version, please look for migration tooling.

  • namespace: string | AppInfo
  • Optional permissions?: Permissions

    Permissions to ask a root authority.

  • Optional userMessages?: UserMessages

    Configure messages that webnative sends to users.

    versionMismatch.newer is shown when webnative detects that the user's filesystem is newer than what this version of webnative supports. versionMismatch.older is shown when webnative detects that the user's filesystem is older than what this version of webnative supports.

Generated using TypeDoc