@cfxlabsinc/b2b-services
    Preparing search index...

    Interface ServiceRuntimeEnvArgs

    interface ServiceRuntimeEnvArgs {
        appName: string;
        cache?: boolean;
        dbReader?: boolean;
        dbUser: string;
        maintenanceServiceId?: string | false;
        sentryProject: SentryProject;
        valkeyWorkloadName?: string;
    }
    Index
    appName: string

    Package name without the cfx- prefix, e.g. swap-api.

    cache?: boolean

    Set for a service with a cache identity: VALKEY_URL is the login cfx-db publishes for it.

    dbReader?: boolean

    Also emit DATABASE_RO_URL, for a workload that routes read paths onto the replica.

    dbUser: string

    The literal Postgres role cfx-db declares for the workload, e.g. swap_api_rw. A plain string, since that role is in another stack. Its published login is what dbWorkloadEnv reads.

    maintenanceServiceId?: string | false

    MAINTENANCE_SERVICE_ID, defaulting to cfx-<appName>. Pass false for a function that is not independently maintenance-gated.

    sentryProject: SentryProject
    valkeyWorkloadName?: string

    Valkey AUTH username, when it is not appName. A package that runs two functions off one bundle gives each its own cache identity, e.g. reward-events alongside reward-api.