Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu

$function (Stream Processing)

La expresión $function especifica una función JavaScript personalizada que se puede definir para ejecutar código JavaScript en cada documento de la corriente.

El operador $function tiene la siguiente sintaxis:

{
$function: {
body: <code>,
args: <array expression>,
lang: "js"
}
}
Campo
Tipo
Descripción

string o código

La definición de la función. Puedes especificar la definición de la función como código de tipo BSON o string. Consulta también lang.

function(arg1, arg2, ...) { ... }

or

"function(arg1, arg2, ...) { ... }"

Arreglo

Argumentos pasados a la función body. Si la función body no recibe ningún argumento, puedes especificar un arreglo vacío [ ].

Los elementos de arreglo pueden ser de cualquier tipo BSON, incluido Código. Ver Ejemplo 2: Alternativa a $where.

String

El lenguaje utilizado en el cuerpo. Debes especificar lang: "js".

La expresión ejecuta la función especificada en cada documento del $function flujo. La función puede tomar argumentos del documento o de la matriz args.

La función puede retornar cualquier tipo de BSON, incluyendo un arreglo o un tipo Code. El valor devuelto se utiliza como la salida de la expresión $function.