Type Alias ILockProvider

Type declaration

• create:function

  • create(key, settings?): ILock

  • The create method is used to create an instance of ILock. You can provide a custom owner using the settings.owner field. If not specified a unique owner will be generated by default. You can also provide a TTL value using the settings.ttl field. If not specified it defaults to null, meaning no TTL is applied.

    Parameters

    • key: OneOrMore<string>
    • Optionalsettings: LockProviderCreateSettings

    Returns ILock

• getGroup:function

  • getGroup(): string

  • The getGroup method returns the group name.

    Returns string