Elasticlunr v0.6.6

Elasticlunr.DocumentStore (Elasticlunr v0.6.6) View Source

Link to this section Summary

Types

t()

Functions

add(store, ref, document)
add_field_length(store, ref, field, length)
exists?(document_store, ref)
get(document_store, ref)
get_field_length(store, ref, field)
new(save \\ true)
remove(store, ref)
reset(document_store, save \\ true)
update_field_length(store, ref, field, length)

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Elasticlunr.DocumentStore{
  document_info: map(),
  documents: map(),
  length: pos_integer(),
  save: boolean()
}

Link to this section Functions

Link to this function

add(store, ref, document)

View Source

Specs

add(t(), Elasticlunr.Field.document_ref(), map()) :: t()
Link to this function

add_field_length(store, ref, field, length)

View Source

Specs

add_field_length(
  t(),
  Elasticlunr.Field.document_ref(),
  Elasticlunr.Index.document_field(),
  pos_integer()
) :: t()
Link to this function

exists?(document_store, ref)

View Source

Specs

exists?(t(), Elasticlunr.Field.document_ref()) :: boolean()
Link to this function

get(document_store, ref)

View Source

Specs

get(t(), Elasticlunr.Field.document_ref()) :: map() | nil
Link to this function

get_field_length(store, ref, field)

View Source

Specs

get_field_length(
  t(),
  Elasticlunr.Field.document_ref(),
  Elasticlunr.Index.document_field()
) ::
  pos_integer()
Link to this function

new(save \\ true)

View Source

Specs

new(boolean()) :: t()
Link to this function

remove(store, ref)

View Source

Specs

remove(t(), Elasticlunr.Field.document_ref()) :: map() | nil
Link to this function

reset(document_store, save \\ true)

View Source

Specs

reset(t(), boolean()) :: t()
Link to this function

update_field_length(store, ref, field, length)

View Source

Specs

update_field_length(
  t(),
  Elasticlunr.Field.document_ref(),
  Elasticlunr.Index.document_field(),
  pos_integer()
) :: t()