create: add a short docstring for `makeSimpleCreator`

pull/1129/head
Jordi Gutiérrez Hermoso 2 months ago committed by jordigh
parent 9b3ae08ece
commit 09871480ba

@ -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,

Loading…
Cancel
Save