From 09871480ba576317d1af0188e01caafb9474fbe7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jordi=20Guti=C3=A9rrez=20Hermoso?= Date: Fri, 26 Jul 2024 12:55:16 -0400 Subject: [PATCH] create: add a short docstring for `makeSimpleCreator` --- app/server/lib/ICreate.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/app/server/lib/ICreate.ts b/app/server/lib/ICreate.ts index bf6fa69d..5ebdc344 100644 --- a/app/server/lib/ICreate.ts +++ b/app/server/lib/ICreate.ts @@ -75,6 +75,15 @@ export interface ICreateTelemetryOptions { create(dbManager: HomeDBManager, gristConfig: GristServer): ITelemetry|undefined; } +/** + * This function returns a `create` object that defines various core + * aspects of a Grist installation, such as what kind of billing or + * sandbox to use, if any. + * + * The intended use of this function is to initialise Grist with + * different settings and providers, to facilitate different editions + * such as standard, enterprise or cloud-hosted. + */ export function makeSimpleCreator(opts: { deploymentType: GristDeploymentType, sessionSecret?: string,