Elasticlunr v0.6.6

Elasticlunr.Pipeline behaviour (Elasticlunr v0.6.6) View Source

Link to this section Summary

Types

t()

Callbacks

call(t)

Functions

add(pipeline, module)
default_runners()
insert_after(pipeline, module, before_module)
insert_before(pipeline, module, before_module)
new(callbacks \\ [])
remove(pipeline, module)
run(pipeline, tokens)

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Elasticlunr.Pipeline{callback: [module() | function()]}

Link to this section Callbacks

Link to this callback

call(t)

View Source

Specs

call(Elasticlunr.Token.t()) ::
  Elasticlunr.Token.t() | [Elasticlunr.Token.t()] | nil

Link to this section Functions

Link to this function

add(pipeline, module)

View Source

Specs

add(t(), module()) :: t()
Link to this function

default_runners()

View Source

Specs

default_runners() :: [module()]
Link to this function

insert_after(pipeline, module, before_module)

View Source

Specs

insert_after(t(), module(), module()) :: t()
Link to this function

insert_before(pipeline, module, before_module)

View Source

Specs

insert_before(t(), module(), module()) :: t()
Link to this function

new(callbacks \\ [])

View Source

Specs

new([module()]) :: struct()
Link to this function

remove(pipeline, module)

View Source

Specs

remove(t(), module()) :: t()
Link to this function

run(pipeline, tokens)

View Source

Specs

run(t(), [Elasticlunr.Token.t()]) :: [Elasticlunr.Token.t()]