elastic.js: Module: ScriptScoreFunction


        ScriptScoreFunction ( )

Modify a documents score using a script.

Returns	Name	Description
`String`	`_type()`	The type of ejs object. For internal use only.
`Object`	`filter(oFilter)`	Adds a filter whose matching documents will have the score function applied.
`Object`	`lang(language)`	The script language being used.
`Object`	`params(p)`	Sets parameters that will be applied to the script. Overwrites any existing params.
`Object`	`script(scriptCode)`	Set the script that will modify the score.
`Object`	`scriptId(scriptId)`	Set the script id that will modify the score.
`String`	`toJSON()`	Retrieves the internal `agg` object. This is typically used by internal API functions so use with caution.


        String _type ( )

The type of ejs object. For internal use only.


        Object filter ( oFilter )

Adds a filter whose matching documents will have the score function applied.


        Object lang ( language )

The script language being used.


        Object params ( p )

Sets parameters that will be applied to the script. Overwrites any existing params.

Parameters: p <Object> An object where the keys are the parameter name and values are the parameter value.
Returns: returns this so that calls can be chained.


        Object script ( scriptCode )

Set the script that will modify the score.


        Object scriptId ( scriptId )

Set the script id that will modify the score.


        String toJSON ( )

Retrieves the internal agg object. This is typically used by internal API functions so use with caution.