Represents information about invocation of a method on NoSQLClient instance. Contains the method that was called and its parameters including the options opt parameter. Operation object may be used in the following ways:

  • It is available as operation property allowing the error code to examine the operation that caused the error.
  • It is available as parameter to NoSQLClient events allowing to customize the behavior of event hanlders depending on what operation has caused the event.
  • It is available as parameter to methods of RetryHandler. If the application is using custom retry handler, it can customize the retry logic based on what operation has caused the retryable error.
  • It is available as parameter to getAuthorization method of authorization provider. If the application is using custom authorization mechanism, it can customize its behavior based on what operation requires authorization.

Note that the opt property also extends Config object with which NoSQLClient instance was created, so in addition to properties in opt argument you may use opt to access all additional properties of Config.

Besides the properties described below, the remaining properties of Operation object represent parameters passed to the NoSQLClient method and are named as such. The values of these properties are the values passed as corresponding parameters of the method. E.g. if the method takes parameter tableName with value 'Employee' then the Operation object will have property tableName: 'Employee'.

Hierarchy

  • Operation

Indexable

[name: string]: any

Properties

Properties

api: Function

The API represented by the operation, which is the instance method of NoSQLClient class.

opt?: object

opt parameter that is passed to NoSQLClient methods. Extends Config.

Generated using TypeDoc