Options
All
  • Public
  • Public/Protected
  • All
Menu

Module functions/store

Index

Interfaces

Variables

Functions

Variables

Const lf

lf: { config: LocalForage; list: LocalForage } = ...

Type declaration

  • config: LocalForage
  • list: LocalForage

Functions

addArticleToList

  • addArticleToList(name: string, article: any): Promise<any>

  • Add a Article to a List

    Parameters

    • name: string

      List Name

    • article: any

      article to add

    Returns Promise<any>

    Success or Failure Response

deleteConfig

  • deleteConfig(did: string): Promise<any>

  • Delete a config associated with a DID

    Parameters

    • did: string

      DID

    Returns Promise<any>

    Success or Failure Response

deleteKeyPair

  • deleteKeyPair(kid: string): Promise<any>

  • Delete Key Pair associated with KID

    Parameters

    • kid: string

      KID

    Returns Promise<any>

deleteList

  • deleteList(name: string): Promise<any>

  • Delete a List with given name

    Parameters

    • name: string

      List Name

    Returns Promise<any>

    Success or Failure Response

getAllConfigs

  • getAllConfigs(): Promise<any>

  • Return all configs

    Returns Promise<any>

    List

getAllDids

  • getAllDids(): Promise<any>

  • Return a List of DIDS from the Config

    Returns Promise<any>

    list

getAllKeyPairs

  • getAllKeyPairs(): Promise<any>

  • Return a Specific DID from the config

    Returns Promise<any>

    DID Document

getAllLists

  • getAllLists(): Promise<any>

  • Iterate over and return all lists

    Returns Promise<any>

    all lists found

getConfig

  • getConfig(did: string): Promise<any>

  • Retrieve a specific config based on DID

    Parameters

    • did: string

      DID

    Returns Promise<any>

    config

getDid

  • getDid(did: string): Promise<any>

  • Return a Specific DID from the config

    Parameters

    • did: string

      DID to find

    Returns Promise<any>

    DID Document

getKeyPair

  • getKeyPair(kid: string): Promise<boolean | string>

  • Locate a Key Pair based on provided KID

    Parameters

    • kid: string

      KID

    Returns Promise<boolean | string>

    False or Key Pair

getList

  • getList(name: string): Promise<any>

  • Retrieve a list based on its name

    Parameters

    • name: string

      List Name

    Returns Promise<any>

    empty array or found list

importConfig

  • Import a new config

    Parameters

    • config: any

    Returns Promise<ActionResponse>

    Success or Failure Response Object

importList

  • importList(name: string, endpoint: string, key: string, items?: string): Promise<ActionResponse>

  • Import a List from a URL Endpoint

    Parameters

    • name: string

      List Name

    • endpoint: string

      URL Endpoint

    • key: string

      List Key

    • items: string = ''

      List Items

    Returns Promise<ActionResponse>

    Success or Failure Message Object

parseListKey

  • parseListKey(name: string): string

  • Parse List Key to Lower Case and Replace Spaces with Dashes

    Parameters

    • name: string

      List Name

    Returns string

    List Key

putConfig

  • putConfig(did: string, config: any): Promise<any>

  • Update or Create a new Config

    Parameters

    • did: string

      DID to be associated with

    • config: any

      config to create

    Returns Promise<any>

    Success or Failure Response

putList

  • putList(list: any): Promise<any>

  • Create or Update a List

    Parameters

    • list: any

    Returns Promise<any>

    Success or Failure Response