Function Configuration Files

Atlas App Services ha alcanzado su estado de fin de vida útil y ya no recibe soporte activo por parte de MongoDB. Los activadores siguen disponibles en la Interfaz de Usuario de Atlas. Remítase a deprecation page for details.

Nota

Esta página describe un formato de archivo de configuración heredado. Solo debe usar esta información si está usando el formato obsoleto. realm-cli.

Cualquier archivo de configuración que extraiga con la CLI de App Services o exporte desde la interfaz de usuario utiliza la versión más reciente. Para obtener información detallada sobre el formato actual de los archivos de configuración, consulte Configuración de la aplicación.

app/
└── functions/
    ├── config.json
    └── <function>.js

Manifiesto de Función

Cada función de su aplicación tiene una entrada de metadatos correspondiente en el archivo de manifiesto de función:. /functions/config.json

Tip

Atlas App Services automatically adds functions to the manifest on import if they don't already have a configuration defined. If you're okay with the default settings, you can skip defining the configuration for a function and let App Services do it for you. The manifest will include the generated configurations the next time you export or pull your app.

functions/config.json

[
  {
    "name": "<Function Name>",
    "private": <Boolean>,
    "can_evaluate": { <JSON Expression> },
    "disable_arg_logs": <Boolean>,
    "run_as_system": <Boolean>,
    "run_as_user_id": "<App Services User ID>",
    "run_as_user_id_script_source": "<Function Source Code>"
  },
  ...
]

Campo	Descripción
`name` String	El nombre de la función. Debe coincidir con el nombre del archivo de código fuente y ser único entre todas las funciones de la aplicación.
`private` Boolean	Si `true` es, esta función solo se puede llamar desde otras funciones o en expresiones de regla. No se puede llamar a una función privada directamente desde una aplicación cliente ni con un `%function` SDK.
`can_evaluate` JSON Expression (default: `true`)	Una expresión JSON que evalúa `true` como si se permite la ejecución de la función. App Services evalúa esta expresión para cada solicitud entrante.
`disable_arg_logs` Boolean	Si `true`, App Services omite los argumentos proporcionados a la función en la entrada del registro de ejecución de la función.
`run_as_system` Boolean	Si `true`, esta función se ejecuta como el usuario del sistema. Esto reemplaza cualquier valor definido para `run_as_user_id` y `run_as_user_id_script_source`.
`run_as_user_id` String	El ID único de un usuario de App Services con el que siempre se ejecuta la función. No se puede usar `run_as_user_id_script_source` con.
`run_as_user_id_script_source` String	Una función convertida a string que se ejecuta cada vez que se llama la función y retorna el ID único de un usuario de App Services bajo cuyos permisos se ejecuta esta función. No se puede utilizar con `run_as_user_id`.

Function Source Code

Defines el código fuente de una función en un archivo .js dentro del directorio /functions, que usa el nombre de la función como nombre de archivo. Cada archivo debe exportar la función principal que se ejecuta cada vez que una solicitud llama a la función.

Importante

Todos los archivos de código fuente de sus funciones deben estar en el directorio /functions.

/functions/<nombre de<function name> función>.js

exports = function addOne(input) {
  if(typeof input !== "number") {
    throw new Error("You must call addOne() with a number");
  }
  return input + 1;
};

¿Qué son los servicios de aplicación Atlas?