Class LargeSync

constructor

• new LargeSync(): LargeSync

  Returns LargeSync

ReadonlymaxBytes

ReadonlymaxBytesPerKey

Readonlyversion

basicHash

• basicHash(str: string): number

  A basic hash function.

  Parameters

  • str: string

    The string to be hashed.

  Returns number

  The hash of the string.

calculateMaxLength

• calculateMaxLength(key: string, maxLength: number): number

  Calculates the maximum length of a chunk.

  Parameters

  • key: string

    The key of the chunk.
  • maxLength: number

    The maximum length of the chunk.

  Returns number

  The maximum length of the chunk.

clear

• clear(callback: () => void): void

  Clears all objects from chrome.storage.sync.

  Parameters

  • callback: () => void

    The callback function.

  Returns void

extractKeys

• extractKeys(splitObjects: any): string[]

  Extracts the keys from a split object.

  Parameters

  • splitObjects: any

    The split object.

  Returns string[]

  The keys of the object.

get

• get(keys: string[], callback: (arg: { [k: string]: any }) => void): void

  Gets an object from chrome.storage.sync.

  Parameters

  • keys: string[]

    The keys of the object to be retrieved.
  • callback: (arg: { [k: string]: any }) => void

    The callback function.

  Returns void

getBytesInUse

• getBytesInUse(keys: string[], callback: () => void): void

  Gets the bytes in use by an object in chrome.storage.sync.

  Parameters

  • keys: string[]

    The keys of the object.
  • callback: () => void

    The callback function.

  Returns void

getKeyPrefix

• getKeyPrefix(): string

  Gets the key prefix.

  Returns string

  The key prefix.

getKeys

• getKeys(keys: any): string[]

  Gets the keys of an object.

  Parameters

  • keys: any

    The object.

  Returns string[]

  The keys of the object.

getRequestKeys

• getRequestKeys(keys: string[]): string[]

  Gets the request keys for a given set of keys.

  Parameters

  • keys: string[]

    The keys.

  Returns string[]

  The request keys.

getStorageKey

• getStorageKey(key: string, postfix: string): string

  Gets the storage key for a given key and postfix.

  Parameters

  • key: string

    The key.
  • postfix: string

    The postfix.

  Returns string

  The storage key.

reconstruct

• reconstruct(
      splitObjects: any,
      inKeys?: undefined | string[],
  ): { [k: string]: any }

  Reconstructs an object from its chunks.

  Parameters

  • splitObjects: any

    The object with the split chunks.
  • inKeys: undefined | string[] = undefined

    The keys of the object to be reconstructed.

  Returns { [k: string]: any }

  The reconstructed object.

remove

• remove(keys: string[], callback: () => void): void

  Removes an object from chrome.storage.sync.

  Parameters

  • keys: string[]

    The keys of the object to be removed.
  • callback: () => void

    The callback function.

  Returns void

set

• set(items: { [k: string]: any }, callback: () => void): void

  Sets an object in chrome.storage.sync.

  Parameters

  • items: { [k: string]: any }

    The object to be stored.
  • callback: () => void

    The callback function.

  Returns void

setKeyPrefix

• setKeyPrefix(val: string): void

  Sets the key prefix.

  Parameters

  • val: string

    The new key prefix.

  Returns void

split

• split(obj: any, maxLength: number): object

  Splits an object into smaller chunks to be stored in chrome.storage.sync.

  Parameters

  • obj: any

    The object to be stored.
  • maxLength: number

    The maximum length of each chunk.

  Returns object

  The object with the split chunks.