Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StorageAdapter

Storage adapter class, extended to connect brain with external storage provider. Methods are just raw endpoints to be extended.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

bot

bot: Bot

name

name: string = "storage-adapter"

Methods

Abstract find

  • find(collection: string, params: any): Promise<any>
  • find(collection: string, params: any): Promise<any>

  • Parameters

    • collection: string
    • params: any

    Returns Promise<any>

  • Query subset of collection from storage provider

    Parameters

    • collection: string
    • params: any

    Returns Promise<any>

Abstract findOne

  • findOne(collection: string, params: any): Promise<any>
  • findOne(collection: string, params: any): Promise<any>

  • Parameters

    • collection: string
    • params: any

    Returns Promise<any>

  • Query subset of collection from storage provider, returning single item

    Parameters

    • collection: string
    • params: any

    Returns Promise<any>

Abstract keep

  • keep(collection: string, data: any): Promise<void>
  • keep(collection: string, data: any): Promise<void>

  • Parameters

    • collection: string
    • data: any

    Returns Promise<void>

  • Add data to series in given collection

    Parameters

    • collection: string
    • data: any

    Returns Promise<void>

Abstract loadMemory

  • loadMemory(): Promise<any>
  • loadMemory(): Promise<any>

  • Returns Promise<any>

  • Get memory data for brain

    Returns Promise<any>

Abstract lose

  • lose(collection: string, params: any): Promise<void>
  • lose(collection: string, params: any): Promise<void>

  • Parameters

    • collection: string
    • params: any

    Returns Promise<void>

  • Remove anything from collection in storage that matches params

    Parameters

    • collection: string
    • params: any

    Returns Promise<void>

Abstract saveMemory

  • saveMemory(data: any): Promise<void>
  • saveMemory(data: any): Promise<void>

  • Parameters

    • data: any

    Returns Promise<void>

  • Store memory data from brain

    Parameters

    • data: any

    Returns Promise<void>

Abstract shutdown

  • shutdown(): Promise<void>
  • shutdown(): Promise<void>

Abstract start

  • start(): Promise<void>
  • start(): Promise<void>

Generated using TypeDoc