Stone.js API
    Preparing search index...

    Interface RateLimitAppConfig

    Application config augmented with the rate-limit bucket.

    interface RateLimitAppConfig {
        adapter?: Partial<AdapterConfig<any, any, any, U, any, V>>;
        adapters?: AdapterConfig<
            any,
            any,
            any,
            IncomingEvent,
            any,
            OutgoingResponse,
        >[];
        aliases?: Record<string, any>;
        blueprint?: BlueprintConfig<IBlueprint, any>;
        debug?: boolean;
        env?: Environment;
        fallback_locale?: string;
        kernel?: KernelConfig<IncomingEvent, OutgoingResponse>;
        lifecycleHooks?: LifecycleHookType<
            IBlueprint,
            any,
            any,
            IncomingEvent,
            OutgoingResponse,
        >;
        listeners?: MetaEventListener<any>[];
        liveConfigurations?: MixedConfiguration[];
        locale?: string;
        logger?: LoggerConfig;
        middleware?: MixedPipe<IncomingEvent, OutgoingResponse>[];
        name?: string;
        providers?: MixedServiceProvider[];
        rateLimit: RateLimitConfig;
        secret?: string;
        services?: MetaService[];
        subscribers?: MixedEventSubscriber[];
        timezone?: string;
        [key: string]: unknown;
    }

    Hierarchy

    • Partial<AppConfig>
      • RateLimitAppConfig

    Indexable

    • [key: string]: unknown
    Index
    adapter? adapters? aliases? blueprint? debug? env? fallback_locale? kernel? lifecycleHooks? listeners? liveConfigurations? locale? logger? middleware? name? providers? rateLimit secret? services? subscribers? timezone?
    adapter?: Partial<AdapterConfig<any, any, any, U, any, V>>

    Current Adapter configurations for the application. This key allow you to specify the current adapter with the alias key.

    adapters?: AdapterConfig<any, any, any, IncomingEvent, any, OutgoingResponse>[]

    Adapter configurations for the application. List of all adapters used in the application.

    aliases?: Record<string, any>

    Class aliases to be registered when the application starts. These aliases provide shorthand references to commonly used classes.

    blueprint?: BlueprintConfig<IBlueprint, any>

    Configuration options for building the application blueprint, including middleware and pipe priorities.

    debug?: boolean

    Determines if the application is in debug mode. When enabled, detailed error messages with stack traces will be shown.

    env?: Environment

    The current environment in which the application is running. Possible values are development, production, and test.

    fallback_locale?: string

    The fallback locale used when a translation for the default locale is unavailable.

    kernel?: KernelConfig<IncomingEvent, OutgoingResponse>

    Kernel configurations for the application.

    lifecycleHooks?: LifecycleHookType<
        IBlueprint,
        any,
        any,
        IncomingEvent,
        OutgoingResponse,
    >

    Lifecycle hooks for the application. These hooks allow you to run custom code at different stages of the application lifecycle.

    listeners?: MetaEventListener<any>[]

    Event listeners to be automatically registered when the application starts. This allows you to specify functions to listen for specific events.

    liveConfigurations?: MixedConfiguration[]

    Live configurations are loaded at each request. By default, configurations are loaded once when the application starts. This is useful for defining dynamic configurations that do not require a restart to apply changes.

    locale?: string

    The default locale for the application.

    logger?: LoggerConfig

    Logging settings, including the logger instance and error reporting configurations.

    middleware?: MixedPipe<IncomingEvent, OutgoingResponse>[]

    Middleware configuration options for specific stages of the application lifecycle.

    name?: string

    The name of the application.

    providers?: MixedServiceProvider[]

    Service providers to be automatically loaded for each request to the application.

    rateLimit: RateLimitConfig
    secret?: string

    A secret key used for encryption purposes throughout the application. This key should be kept secure.

    services?: MetaService[]

    Services to be automatically registered when the application starts.

    subscribers?: MixedEventSubscriber[]

    Subscribers to be automatically registered when the application starts. Subscribers are used for handling and responding to events.

    timezone?: string

    The default timezone for the application.

    Settings
    Member Visibility

    On This Page
    Properties