Node SDK

Interface LeoDynamodb

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Property
  • Method
  • Enumeration
  • Class

Helper functions to interact with Dynamo DB.

Hierarchy

  • LeoDynamodb

Index

Properties

docClient: DocumentClient

Methods

  • batchGetHashkey(table: string, hashkey: any, ids: any, opts: any, callback: any): void
  • Parameters

    • table: string
    • hashkey: any
    • ids: any
    • opts: any
    • callback: any

    Returns void

  • batchGetTable(table: string, keys: any, opts: any, callback: any): void
  • batchTableWrite(table: string, records: any, callback: any): void
  • createTableWriteStream(table: string, opts: any): void
  • getSetting<T>(setting_id: string, callback: DataCallback<AWSError, T>): void
  • getSettingPromise<T>(setting_id: string): Promise<T>
  • merge(table: string, id: string, obj: any, opts: any, callback: any): void
  • Parameters

    • table: string
    • id: string
    • obj: any
    • opts: any
    • callback: any

    Returns void

  • put<T>(table: string, id: string, item: T, opts: PutOptions, callback: Callback<AWSError>): void
  • query(params: any, configuration?: any, stats?: any): Promise<any>
  • Parameters

    • params: any
    • Optional configuration: any
    • Optional stats: any

    Returns Promise<any>

  • saveSetting<T>(setting_id: string, value: T, callback: Callback<AWSError>): void
  • scan(table: string, filter: any, callback: any): void
  • setSettingPromise<T>(setting_id: string, value: T): Promise<void>
  • Type parameters

    • T

    Parameters

    • setting_id: string
    • value: T

    Returns Promise<void>

  • update(table: string, key: any, set: any, opts: any, callback: any): void
  • Parameters

    • table: string
    • key: any
    • set: any
    • opts: any
    • callback: any

    Returns void

  • updateMulti(items: any, opts: any, callback: any): void

Generated using TypeDoc