yorkie/dev.yorkie.document/Document/Options

Options

data class Options @JvmOverloads constructor(val disableGC: Boolean = false, val disablePresence: Boolean = false, val maxUndoDepth: Int = MaxUndoRedoStackDepth)

Constructors

Options

@JvmOverloads

constructor(disableGC: Boolean = false, disablePresence: Boolean = false, maxUndoDepth: Int = MaxUndoRedoStackDepth)

Properties

disableGC

val disableGC: Boolean = false

Disables garbage collection if true.

disablePresence

val disablePresence: Boolean = false

Seeds the presence-free state before attach. The server-fixated value from the attach response takes precedence once attached.

maxUndoDepth

val maxUndoDepth: Int

How many entries history.undo() can go back, and likewise for history.redo(). Each updateAsync that changes the document is one entry; the oldest is dropped once a stack is full. Must be a positive integer, otherwise construction throws YorkieException with ErrInvalidArgument. Defaults to 50. A reverse entry keeps a copy of the content it would restore, so a larger depth holds more memory.