Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2024-10-27 20:44:07 +00:00
Code Issues Projects Releases Wiki Activity

create: add a short docstring for makeSimpleCreator

Browse Source
This commit is contained in:
Jordi Gutiérrez Hermoso 2024-07-26 12:55:16 -04:00 committed by jordigh
parent 9b3ae08ece
commit 09871480ba
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
app/server/lib/ICreate.ts
View File

@ -75,6 +75,15 @@ export interface ICreateTelemetryOptions {
create(dbManager: HomeDBManager, gristConfig: GristServer): ITelemetry|undefined; 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: { export function makeSimpleCreator(opts: {
deploymentType: GristDeploymentType, deploymentType: GristDeploymentType,
sessionSecret?: string, sessionSecret?: string,