Interface DataStore<V>

Type Parameters

Hierarchy

  • DataStore

Implemented by

Methods

clear containsKey containsValue delete get getDataStoreFactory getId isEmpty keySet set size values

Methods

clear

  • Deletes all of the stored keys and values.

    Returns DataStore<V>

containsKey

  • Returns whether the store contains the given key.

    Parameters

    • key: string

    Returns boolean

containsValue

  • Returns whether the store contains the given value.

    Parameters

    • value: V

    Returns any

delete

  • Deletes the stored key and value based on the given key, or ignored if the key doesn't already exist.

    Parameters

    • key: string

      key or null to ignore

    Returns DataStore<V>

get

  • Returns the stored value for the given key or null if not found.

    Parameters

    • key: string

      key or null for null result

    Returns V

getDataStoreFactory

getId

  • Returns the data store ID.

    Returns string

isEmpty

  • Returns whether there are any stored keys.

    Returns boolean

keySet

  • Returns the unmodifiable set of all stored keys.

    Order of the keys is not specified.

    Returns Set<string>

set

  • Stores the given value for the given key (replacing any existing value).

    Parameters

    • key: string

      key

    • value: V

      value object

    Returns DataStore<V>

size

  • Returns the number of stored keys.

    Returns number

values

  • Returns the unmodifiable collection of all stored values.

    Returns Collection<V>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc