Options
All
  • Public
  • Public/Protected
  • All
Menu

@grouparoo/core

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

CacheKey: {} | CacheKey[] | string | number | boolean | Date
DestinationMappingOptionsResponseType: "any" | "boolean" | "date" | "email" | "float" | "integer" | "number" | "phoneNumber" | "string" | "url"
DestinationSyncMode: typeof SYNC_MODES[number]
ExportArrayPropertiesMethodResponse: string[]
GrouparooRunMode: "cli:run" | "cli:start" | "cli:config" | "cli:apply" | "cli:validate"
ParamsFrom<A>: Pick<ParamsExtractor<A>, RequiredParamsKeys<A>> & Partial<ParamsExtractor<A>>

Type parameters

  • A: ActionheroWithParams

PluginOptionType: "list" | "typeahead" | "text" | "textarea" | "password" | "oauth-token" | "pending"
RecordPropertiesPluginMethodResponse: {}

Type declaration

RecordPropertyPluginMethodResponse: (string | number | boolean | Date)[]
oAuthType: "user" | "app"

Variables

PropertyTypes: readonly ["boolean", "date", "email", "float", "integer", "phoneNumber", "string", "url"] = ...

Functions

  • makeBaseCacheKey(__namedParameters: { cacheKey: CacheKey; objectId: string }): string
  • objectCache(argument: { cacheDurationMs?: number; cacheKey: CacheKey; lock?: boolean; objectId: string; passthru?: boolean; read?: boolean; write?: boolean }, methodToGetValue: () => Promise<any>): Promise<any>
  • Parameters

    • argument: { cacheDurationMs?: number; cacheKey: CacheKey; lock?: boolean; objectId: string; passthru?: boolean; read?: boolean; write?: boolean }
      • Optional cacheDurationMs?: number
      • cacheKey: CacheKey
      • Optional lock?: boolean
      • objectId: string
      • Optional passthru?: boolean
      • Optional read?: boolean
      • Optional write?: boolean
    • methodToGetValue: () => Promise<any>
        • (): Promise<any>
        • Returns Promise<any>

    Returns Promise<any>

  • objectCacheInvalidate(argument: { objectId: string }): Promise<void>
  • waitForLock(key: string, requestId?: string, ttl?: number, attempts?: number, sleepTime?: number): Promise<{ attempts: number; releaseLock: Function }>
  • Parameters

    • key: string
    • requestId: string = ...
    • ttl: number = LOCK_DURATION_MS
    • attempts: number = 0
    • sleepTime: number = RETRY_SLEEP

    Returns Promise<{ attempts: number; releaseLock: Function }>

Generated using TypeDoc