Function withCacheWriteLock

  • withCacheWriteLock(
        settings: WithCacheWriteLockSettings,
    ): PluginFn<ICacheAdapter>

  • Creates a plugin that acquires a distributed lock before executing mutating cache operations.

    This plugin wraps write operations (add, put, update, increment, getAndRemove, removeMany) with a lock acquired via ILockFactory. The lock key is derived from the cache key, ensuring that concurrent writes to the same cache entry are serialised. By default all mutating methods are protected; use onlyMethods to restrict which operations are locked.

    Parameters

    • settings: WithCacheWriteLockSettings

      Configuration for the write-lock behaviour.

      • lockFactory: ILockFactory

        A factory that creates named locks. Each lock is keyed by the cache key to ensure concurrent writes to the same cache entry are serialised while writes to different entries can proceed in parallel.

      • OptionalonlyMethods?: WithCacheWriteLockMethods[]

        The subset of mutating methods to protect with a write lock. When omitted, all mutating methods are protected.

        Default

        ["getAndRemove", "add", "put", "update", "increment", "removeMany", "getOrAdd"]

    Returns PluginFn<ICacheAdapter>

    A middleware plugin that wraps an ICacheAdapter.

    IMPORT_PATH: "@daiso-tech/core/cache/plugins"

Settings

Member Visibility