Device-Sync clientRest mode typescript error

[maichongju]

How frequently does the bug occur?

Always

Description

When setting the clientRest mode on react native with typescript. Typescript will report that the value is not assignable to type ClientResetMode.

The code still works, but it is a bug that should be fixed with the typing issue.

Stacktrace & log output

No response

Can you reproduce the bug?

Always

Reproduction Steps

Add the following code in the app.

<RealmProvider
  schema={[FriendRequest]}
  sync={{
    flexible: true,
    clientReset:{
      mode: 'manual', // <-- Here the type error show up
      onManual: (session, path) => {
        // handle manual client reset here
      },
    },
    onError: (session, error) => {
      logger.error(`Realm sync error: ${error}`);
    }
  }}

>
  // Rest of the code
</RealmProvider>

Version

"realm": "^12.3.1",, "@realm/react": "^0.6.2",

What services are you using?

Atlas Device Sync

Are you using encryption?

No

Platform OS and version(s)

Win11 23H2

Build environment

No response

Cocoapods version

No response

[elle-j]

Hi @maichongju, you can import { ClientResetMode } from "realm" and use that enum for setting the mode.

[maichongju]

Yes. I believe I got misled by the documentation from here and here. As you can see it is telling us to use the string "manual" for the mode. But now I look at other code blocks, they did use the ClientRestMode.

Is there any chance you know how to report this kind of documentation inconsistency?

[elle-j]

Thanks for bringing it to our attention anyway! I'll let our Docs team know 👍

Atlas Device SDK (Realm) docs repo is here: https://github.com/mongodb/docs-realm