Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Function

Hierarchy

  • Function

Index

Properties

Properties

$function

$function: { body: CodeExpression; args: ArrayExpression<any>; lang: "js" }

Defines a custom aggregation function or expression in JavaScript.

version

4.4

see

https://docs.mongodb.com/manual/reference/operator/aggregation/function/#mongodb-expression-exp.-function

Type declaration

  • body: CodeExpression
    The function definition. You can specify the function definition as either BSON type Code or String.
  • args: ArrayExpression<any>

    Arguments passed to the function body. If the body function does not take an argument, you can specify an empty array [ ]

  • lang: "js"

    The language used in the body. You must specify lang: "js".

Generated using TypeDoc