Document Realm.Sync.setSyncLogger

Goals

To implement https://github.com/realm/realm-studio-private/issues/16 it would be great to get a way to intercept messages logged by the sync client.

Expected Results

It would be great to be able to set a callback which would get called when the client wants to log a message, overriding the default behaviour of printing to the console:

enum LogLevel {
    All = 'all'
    Trace = 'trace'
    Debug = 'debug'
    Detail = 'detail'
    Info = 'info'
    Warn = 'warn'
    Error = 'error'
    Fatal = 'fatal'
    Off = 'off'
};

Realm.Sync.setLogCallback((level: LogLevel, message: string) => {
    // Do whatever with the message ...
});

// Because `setLogCallback` was called no messages are logged to the console.

[kraenhansen]

I’ll try it out - thanks! I’ll give it a spin when I get to the issue then 👍 It would be awesome to get it documented though.

[nirinchev]

I don’t know if this should be a separate request, but it would be great if we could reuse that to avoid realm-js logging to the console in general - e.g. in user-methods there’s a print_error method that should use the log callback rather than the console.