backend
    Preparing search index...

    Variable default

    default: {
        BY_ID: "/id/:id";
        BY_NAME: "/name/:name";
        DB_URL: string;
        DB_URL_TEST: string;
        DIST_DIR: "dist";
        INI_ADMIN: string;
        INI_ADMIN_PASSWD: string;
        ITEMS_EP: "/api/items";
        LOG_URL: string;
        NAME_MAX: 50;
        NODE_ENV: string;
        PAGE_DEF: 20;
        PAGE_MAX: 100;
        PASSWD_MAX: 20;
        PASSWD_MIN: 6;
        PORT: number;
        SALT: number;
        SEARCH: "/search";
        SECRET: string;
        SPA: "dist/index.html";
        USERNAME_MAX: 20;
        USERNAME_MIN: 3;
        USERS_EP: "/api/users";
        VER_EP: "/version";
        VERSION: 0;
        cryptAdminPasswd(): Promise<void>;
    }

    Flexible or sensitive configurations are typically from corresponding environment variables, which are set by dotenv locally, or by cloud platforms in deployment. For CICD testing, corresponding environment variables should be set by CICD pipelines only if the configurations are flexible or sensitive for testing. Otherwise, they can be from default. Configurations only for testing don't need to be defined in the cloud for production deployment.

    Type declaration

    • ReadonlyBY_ID: "/id/:id"
    • ReadonlyBY_NAME: "/name/:name"
    • ReadonlyDB_URL: string

      Flexible or sensitive configuration included in .env: should be set in the cloud but unnecessary in CICD pipelines.

    • ReadonlyDB_URL_TEST: string

      Flexible or sensitive configuration included in .env: should be set in CICD pipelines but not in the cloud.

    • ReadonlyDIST_DIR: "dist"
    • ReadonlyINI_ADMIN: string
    • ReadonlyINI_ADMIN_PASSWD: string
    • ReadonlyITEMS_EP: "/api/items"
    • ReadonlyLOG_URL: string

      Flexible or sensitive configuration included in .env: should be set in the cloud but unnecessary in CICD pipelines.

    • ReadonlyNAME_MAX: 50
    • ReadonlyNODE_ENV: string

      Should be set in the CLI.

    • ReadonlyPAGE_DEF: 20
    • ReadonlyPAGE_MAX: 100
    • ReadonlyPASSWD_MAX: 20
    • ReadonlyPASSWD_MIN: 6
    • ReadonlyPORT: number

      Flexible or sensitive configuration included in .env: normally will be automatically set by cloud platforms, so unnecessary to be set in both the cloud and CICD pipelines.

    • ReadonlySALT: number
    • ReadonlySECRET: string

      Flexible or sensitive configuration included in .env: should be set in the cloud but unnecessary in CICD pipelines.

    • ReadonlySPA: "dist/index.html"
    • ReadonlyUSERNAME_MAX: 20
    • ReadonlyUSERNAME_MIN: 3
    • ReadonlyUSERS_EP: "/api/users"
    • ReadonlyVER_EP: "/version"
    • ReadonlyVERSION: 0
    • cryptAdminPasswd: function

    Settings

    Member Visibility