Options
All
  • Public
  • Public/Protected
  • All
Menu

Abstracted data store access interface

In general, you will be accessing an archivist instance through a state object:

state.archivist.set('player', { userId: userId }, { name: 'someone' });

Hierarchy

  • Archivist

Index

Methods

add

  • Add a new topic value by index.

    Note that if the index already exists, this call will return an error. Use set instead if you wish to write the value regardless of whether it already exists.

    memberof

    Archivist

    Type parameters

    • T

    Parameters

    Returns void

del

  • Delete a topic by index.

    memberof

    Archivist

    Parameters

    Returns void

distribute

exists

get

getValue

list

mget

mgetValues

set

touch

  • touch(topicName: string, index: IArchivistIndex, expirationTime?: number): void
  • memberof

    Archivist

    Parameters

    Returns void