Nested field support for index setup

When I have documents with a structure like:

{
  name: "Some name",
  address: {
    street: "Main Street",
    number: "42",
    city: "Some Town"
  }
}

I’d like to search among the city field but I can only specify fields on the top level of the document when setting up my index:

var index = lunr(function () {
    this.field('address')
});

It would be nice, if I could specify a nested field for indexing. Something like this:

var index = lunr(function () {
    this.field('address.city');
    //or maybe:
    this.field(['address', 'city']);
});

[olivernn]

This is a request that comes up quite a lot.

The reason I haven’t implemented this change is that I think it can (and should) be done outside of lunr, since the structure of the document is very specific to each user.

In your use case you would just need to have a conversion function that maps your document to something that can be indexed:

var mapper = function (document) {
  return {
    name: document.name,
    city: document.address.city,
    street: document.address.street
  }
}

var idx = lunr(function () {
  this.field('name')
  this.field('city')
  this.field('street')
})

idx.add(mapper(document))

This also gives you the flexibility to combine certain fields into a single field to be indexed by lunr or doing any other conversion you want before lunr starts to index the fields.

[olivernn]

@Petesta the search method does not return the documents that match, instead it returns a reference, i.e. the id of the document. The results are covered in more detail in the search results docs, they look like this:

[{
  "ref": "123",
  "score": 0.123456,
  "metadata": {...}
}]