Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "PartitionKeyGenerators"

Index

Type aliases

Object literals

Type aliases

PartitionKeyGenerator

PartitionKeyGenerator: (requestEnvelope: RequestEnvelope) => string

Type definition of function used by {@link MongoDbPersistenceAdapter} to extract attributes id from {@link RequestEnvelope}.

Type declaration

    • (requestEnvelope: RequestEnvelope): string
    • Parameters

      • requestEnvelope: RequestEnvelope

      Returns string

Object literals

Const PartitionKeyGenerators

PartitionKeyGenerators: object

Object containing implementations of PartitionKeyGenerator.

checkSystemExists

  • checkSystemExists(requestEnvelope: RequestEnvelope): boolean
  • Parameters

    • requestEnvelope: RequestEnvelope

    Returns boolean

deviceId

  • deviceId(requestEnvelope: RequestEnvelope): string
  • Gets attributes id using device id.

    Parameters

    • requestEnvelope: RequestEnvelope

    Returns string

getSystem

  • getSystem(requestEnvelope: RequestEnvelope): any
  • Parameters

    • requestEnvelope: RequestEnvelope

    Returns any

getSystemDevice

  • getSystemDevice(requestEnvelope: RequestEnvelope): any
  • Parameters

    • requestEnvelope: RequestEnvelope

    Returns any

getSystemUser

  • getSystemUser(requestEnvelope: RequestEnvelope): any
  • Parameters

    • requestEnvelope: RequestEnvelope

    Returns any

personId

  • personId(requestEnvelope: RequestEnvelope): string
  • Gets attributes id using person id. Fallback to fetching attributes id using user id, if personId is not present.

    Parameters

    • requestEnvelope: RequestEnvelope

    Returns string

throwException

  • throwException(partitionUsed: string): void
  • Parameters

    • partitionUsed: string

    Returns void

userId

  • userId(requestEnvelope: RequestEnvelope): string
  • Gets attributes id using user id.

    Parameters

    • requestEnvelope: RequestEnvelope

    Returns string

Generated using TypeDoc