Type alias Configuration

Type declaration

• Optional debug?: boolean

  Enable debug mode.

  Default

  false

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

  Debugging settings.

  • Optional emitWindowPostMessages?: boolean

    Should I emit window post messages with session and filesystem information?

    Default

    true

  • 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 the ODD SDK sends to users.

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