Get a range of map items by key

Returns map entries whose keys fall within the lexicographic range [begin, end] (inclusive on both sides).

Usage

am_map_range(doc, obj, begin = "", end = "", heads = NULL)

Arguments

doc

An Automerge document

obj

An Automerge object ID (must be a map), or AM_ROOT

begin

Start key (inclusive). Use "" (default) for unbounded start.

end

End key (inclusive). Use "" (default) for unbounded end.

heads

Optional list of change hashes (raw vectors) for historical query. If NULL (default), uses the current state.

Value

A named list of values in the key range.

Examples

doc <- am_create()
doc$a <- 1
doc$b <- 2
doc$c <- 3
doc$d <- 4

# Get entries with keys in [b, c] -> b and c
range <- am_map_range(doc, AM_ROOT, "b", "c")
names(range)  # "b" "c"
#> [1] "b" "c"

# Get all entries
all <- am_map_range(doc, AM_ROOT, "", "")

am_close(doc)