Interface KvStore

Hierarchy

KvStore

Index

Properties

delete exists get getJson getKeys set setJson

Properties

delete

delete: ((key: string) => void)

Type declaration

- (key: string): void
- Delete the key
  Parameters
  - key: string
    
    The name of the key
  Returns void

exists

exists: ((key: string) => boolean)

Type declaration

- (key: string): boolean
- Checks if the key exists
  
  Returns
  - A boolean
  Parameters
  - key: string
    
    The name of the key
  Returns boolean

get

get: ((key: string) => null | ArrayBuffer)

Type declaration

- (key: string): null | ArrayBuffer
- Gets the value of the key
  
  Returns
  - Either null or an ArrayBuffer
  Parameters
  - key: string
    
    The name of the key
  Returns null | ArrayBuffer

getJson

getJson: ((key: string) => any)

Type declaration

- (key: string): any
- Gets the value of the key
  
  Returns
  - any
  Parameters
  - key: string
    
    The name of the key
  Returns any

getKeys

getKeys: (() => string[])

Type declaration

- (): string[]
- Gets the list of keys
  
  Returns
  - An array of strings
  Returns string[]

set

set: ((key: string, value: string | ArrayBuffer) => void)

Type declaration

- (key: string, value: string | ArrayBuffer): void
- Sets the value for the given key
  Parameters
  - key: string
    
    The name of the key
  - value: string | ArrayBuffer
    
    The value to be set
  Returns void

setJson

setJson: ((key: string, value: any) => void)

Type declaration

- (key: string, value: any): void
- Sets the value for the given key after running a json.stringify
  Parameters
  - key: string
    
    The name of the key
  - value: any
    
    The value to be set
  Returns void

Generated using TypeDoc