Type Alias SharedLockFactorySettingsBase

Type declaration

• OptionalcreateLockId?: Invokable<[], string>

  You can pass your own lock id generator function.

  Default

  import { v4 } from "uuid";
  
  () => v4
  Copy

• OptionaldefaultRefreshTime?: ITimeSpan

  The default refresh time used in the ISharedLock refresh method.

  import { TimeSpan } from "@daiso-tech/core/time-span";
  
  TimeSpan.fromMinutes(5);
  Copy

• OptionaldefaultTtl?: ITimeSpan | null

  You can decide the default ttl value for ISharedLock expiration. If null is passed then no ttl will be used by default.

  Default

  import { TimeSpan } from "@daiso-tech/core/time-span";
  
  TimeSpan.fromMinutes(5);
  Copy

• OptionaleventBus?: EventBusInput

  You can provide an IEventBus or an IEventBusAdapter instance to handle the component's events. If you provide an adapter, it will be automatically wrapped in an EventBus instance.

  Default

  import { NoOpEventBusAdapter } from "@daiso-tech/core/event-bus/no-op-event-bus-adapter";
  
  new NoOpEventBusAdapter()
  Copy

• OptionalexecutionContext?: IExecutionContext

  You can pass IExecutionContext that will be used by context-aware adapters.

  Default

  import { ExecutionContext } from "@daiso-tech/core/execution-context"
  import { NoOpExecutionContextAdapter } from "@daiso-tech/core/execution-context/no-op-execution-context-adapter"
  
  new ExecutionContext(new NoOpExecutionContextAdapter())
  Copy

• Optionalnamespace?: INamespace

  Default

  import { NoOpNamespace } from "@daiso-tech/core/namespace";
  
  new NoOpNamespace()
  Copy

• Optionalserde?: OneOrMore<ISerderRegister>

  You can pass an ISerderRegister instance to the SharedLockFactory to register the shared lock's serialization and deserialization logic for the provided adapter.

  Default

  import { Serde } from "@daiso-tech/core/serde";
  import { NoOpSerdeAdapter } from "@daiso-tech/core/serde/no-op-serde-adapter";
  
  new Serde(new NoOpSerdeAdapter())
  Copy

• OptionalserdeTransformerName?: string

  The serde transformer name used to identify shared-lock serializer and deserializer adapters when there are adapters with the same name.

  Default

  ""
  Copy

• OptionalwaitUntil?: WaitUntil

  You can pass the waitUntil function to handle background promises. This is required when working with environments like Cloudflare Workers or Vercel Functions to ensure tasks complete after the response is sent.

  Default

  import { defaultWaitUntil } from "@daiso-tech/core/utilities"
  Copy