Options
All
  • Public
  • Public/Protected
  • All
Menu

Module storage

Index

Type aliases

Functions

Type aliases

Storage

Storage: ReturnType<typeof asyncStorage>

StorageCallback

StorageCallback: (err?: Error, data?: any) => void

Type declaration

    • (err?: Error, data?: any): void
    • Parameters

      • Optional err: Error
      • Optional data: any

      Returns void

Functions

createStorage

  • createStorage(storage: Storage): { clearStorage: <S>(key: string, filters?: KeyOf<S>[]) => Promise<boolean>; getStorage: <S>(key: string, filters?: KeyOf<S>[]) => Promise<any>; setStorage: <S>(key: string, value: S, filters?: KeyOf<S>[]) => Promise<any> }
  • Parameters

    Returns { clearStorage: <S>(key: string, filters?: KeyOf<S>[]) => Promise<boolean>; getStorage: <S>(key: string, filters?: KeyOf<S>[]) => Promise<any>; setStorage: <S>(key: string, value: S, filters?: KeyOf<S>[]) => Promise<any> }

    • clearStorage: <S>(key: string, filters?: KeyOf<S>[]) => Promise<boolean>
        • <S>(key: string, filters?: KeyOf<S>[]): Promise<boolean>
        • Clears entire storage for store or clears by defined filter key.

          Type parameters

          • S: Record<string, any>

          Parameters

          • key: string

            the storage key for the store.

          • filters: KeyOf<S>[] = []

            key filters to set.

          Returns Promise<boolean>

    • getStorage: <S>(key: string, filters?: KeyOf<S>[]) => Promise<any>
        • <S>(key: string, filters?: KeyOf<S>[]): Promise<any>
        • Gets state from storage.

          Type parameters

          • S: Record<string, any>

          Parameters

          • key: string

            the storage key to retrieve.

          • filters: KeyOf<S>[] = []

            array of keys to filter.

          Returns Promise<any>

    • setStorage: <S>(key: string, value: S, filters?: KeyOf<S>[]) => Promise<any>
        • <S>(key: string, value: S, filters?: KeyOf<S>[]): Promise<any>
        • Persists state to storage.

          Type parameters

          • S: Record<string, any>

          Parameters

          • key: string

            the key used to set storage.

          • value: S

            the value to be set.

          • filters: KeyOf<S>[] = []

            an array of keys to filter from persisted object.

          Returns Promise<any>

Generated using TypeDoc