Class ConfigService

Methods

get getOrThrow

Methods

get

  • get<
        TKey extends
            | "MONGO_URI"
            | "API_PORT"
            | "API_RESPONSE_DELAY"
            | "DANGEROUSLY_DISABLE_PBKDF2_ITERATION"
            | "DEBUG"
            | "LOG"
            | "LOGIN_REQUEST_TROTTLER_LIMIT"
            | "LOGIN_REQUEST_TROTTLER_TTL"
            | "MONGO_DIRECT_CONNECTION"
            | "MONGO_REPLICA_SET"
            | "MONGO_RETRY_WRITES"
            | "MONGO_WRITE_CONCERN"
            | "NODE_ENV"
            | "SECRET_KEY"
            | "THROTTLER_ENABLED"
            | "VERBOSE",
    >(
        key: TKey,
    ): {
        API_PORT: number;
        API_RESPONSE_DELAY?: number;
        DANGEROUSLY_DISABLE_PBKDF2_ITERATION?: boolean;
        DEBUG?: boolean;
        LOG?: boolean;
        LOGIN_REQUEST_TROTTLER_LIMIT?: number;
        LOGIN_REQUEST_TROTTLER_TTL?: number;
        MONGO_DIRECT_CONNECTION?: boolean;
        MONGO_REPLICA_SET?: "rs0";
        MONGO_RETRY_WRITES?: boolean;
        MONGO_URI: URL;
        MONGO_WRITE_CONCERN?: "majority";
        NODE_ENV: "development" | "production" | "test";
        SECRET_KEY: string;
        THROTTLER_ENABLED: boolean;
        VERBOSE?: boolean;
    }[TKey]

    Retrieves a configuration value by key.

    Type Parameters

    • TKey extends
          | "MONGO_URI"
          | "API_PORT"
          | "API_RESPONSE_DELAY"
          | "DANGEROUSLY_DISABLE_PBKDF2_ITERATION"
          | "DEBUG"
          | "LOG"
          | "LOGIN_REQUEST_TROTTLER_LIMIT"
          | "LOGIN_REQUEST_TROTTLER_TTL"
          | "MONGO_DIRECT_CONNECTION"
          | "MONGO_REPLICA_SET"
          | "MONGO_RETRY_WRITES"
          | "MONGO_WRITE_CONCERN"
          | "NODE_ENV"
          | "SECRET_KEY"
          | "THROTTLER_ENABLED"
          | "VERBOSE"

    Parameters

    • key: TKey

      The key of the configuration value to retrieve.

    Returns {
        API_PORT: number;
        API_RESPONSE_DELAY?: number;
        DANGEROUSLY_DISABLE_PBKDF2_ITERATION?: boolean;
        DEBUG?: boolean;
        LOG?: boolean;
        LOGIN_REQUEST_TROTTLER_LIMIT?: number;
        LOGIN_REQUEST_TROTTLER_TTL?: number;
        MONGO_DIRECT_CONNECTION?: boolean;
        MONGO_REPLICA_SET?: "rs0";
        MONGO_RETRY_WRITES?: boolean;
        MONGO_URI: URL;
        MONGO_WRITE_CONCERN?: "majority";
        NODE_ENV: "development" | "production" | "test";
        SECRET_KEY: string;
        THROTTLER_ENABLED: boolean;
        VERBOSE?: boolean;
    }[TKey]

    The configuration value

getOrThrow

  • getOrThrow<
        TKey extends
            | "MONGO_URI"
            | "API_PORT"
            | "API_RESPONSE_DELAY"
            | "DANGEROUSLY_DISABLE_PBKDF2_ITERATION"
            | "DEBUG"
            | "LOG"
            | "LOGIN_REQUEST_TROTTLER_LIMIT"
            | "LOGIN_REQUEST_TROTTLER_TTL"
            | "MONGO_DIRECT_CONNECTION"
            | "MONGO_REPLICA_SET"
            | "MONGO_RETRY_WRITES"
            | "MONGO_WRITE_CONCERN"
            | "NODE_ENV"
            | "SECRET_KEY"
            | "THROTTLER_ENABLED"
            | "VERBOSE",
    >(
        key: TKey,
    ): Exclude<
        {
            API_PORT: number;
            API_RESPONSE_DELAY?: number;
            DANGEROUSLY_DISABLE_PBKDF2_ITERATION?: boolean;
            DEBUG?: boolean;
            LOG?: boolean;
            LOGIN_REQUEST_TROTTLER_LIMIT?: number;
            LOGIN_REQUEST_TROTTLER_TTL?: number;
            MONGO_DIRECT_CONNECTION?: boolean;
            MONGO_REPLICA_SET?: "rs0";
            MONGO_RETRY_WRITES?: boolean;
            MONGO_URI: URL;
            MONGO_WRITE_CONCERN?: "majority";
            NODE_ENV: "development"
            | "production"
            | "test";
            SECRET_KEY: string;
            THROTTLER_ENABLED: boolean;
            VERBOSE?: boolean;
        }[TKey],
        undefined,
    >

    Retrieves a configuration value by key, throwing an error if the value is undefined.

    Type Parameters

    • TKey extends
          | "MONGO_URI"
          | "API_PORT"
          | "API_RESPONSE_DELAY"
          | "DANGEROUSLY_DISABLE_PBKDF2_ITERATION"
          | "DEBUG"
          | "LOG"
          | "LOGIN_REQUEST_TROTTLER_LIMIT"
          | "LOGIN_REQUEST_TROTTLER_TTL"
          | "MONGO_DIRECT_CONNECTION"
          | "MONGO_REPLICA_SET"
          | "MONGO_RETRY_WRITES"
          | "MONGO_WRITE_CONCERN"
          | "NODE_ENV"
          | "SECRET_KEY"
          | "THROTTLER_ENABLED"
          | "VERBOSE"

    Parameters

    • key: TKey

      The key of the configuration value to retrieve.

    Returns Exclude<
        {
            API_PORT: number;
            API_RESPONSE_DELAY?: number;
            DANGEROUSLY_DISABLE_PBKDF2_ITERATION?: boolean;
            DEBUG?: boolean;
            LOG?: boolean;
            LOGIN_REQUEST_TROTTLER_LIMIT?: number;
            LOGIN_REQUEST_TROTTLER_TTL?: number;
            MONGO_DIRECT_CONNECTION?: boolean;
            MONGO_REPLICA_SET?: "rs0";
            MONGO_RETRY_WRITES?: boolean;
            MONGO_URI: URL;
            MONGO_WRITE_CONCERN?: "majority";
            NODE_ENV: "development"
            | "production"
            | "test";
            SECRET_KEY: string;
            THROTTLER_ENABLED: boolean;
            VERBOSE?: boolean;
        }[TKey],
        undefined,
    >

    The configuration value.

    Throws

    Error if the configuration value is undefined.

Settings

Member Visibility

On This Page

Methods