Class default<T>

constructor

• new default<T extends OneObjectTypes>(
      runtimeCheckTypes: T["$type$"][],
  ): default<T>

  Type Parameters

  • T extends OneObjectTypes

  Parameters

  • runtimeCheckTypes: T["$type$"][]

  Returns default<T>

onError

onUpdate

loadObjectIntoCache

• loadObjectIntoCache(objHash: SHA256Hash<T>): void

  Load the object and put it in the cache.

  After successful loading the onUpdate event is emitted.

  Parameters

  • objHash: SHA256Hash<T>

    Hash of object to load.

  Returns void

loadObjectIntoCacheWithRuntimeCheck

• loadObjectIntoCacheWithRuntimeCheck(objHash: SHA256Hash): void

  Same as loadObjectIntoCache, except that it does a runtime check on $type$ field.

  The runtime check is done against the values passed in the constructor. If the runtime check fails the onError event will fire.

  Parameters

  • objHash: SHA256Hash

  Returns void

queryObject

• queryObject(objHash: SHA256Hash<T>): undefined | T

  Get the object from the cache or undefined if it is not cached.

  Parameters

  • objHash: SHA256Hash<T>

  Returns undefined | T

queryOrLoadObjectIntoCache

• queryOrLoadObjectIntoCache(objHash: SHA256Hash<T>): Promise<T>

  Load the object or query it from cache if it was loaded previously.

  Parameters

  • objHash: SHA256Hash<T>

  Returns Promise<T>

queryOrLoadObjectIntoCacheWithRuntimeCheck

• queryOrLoadObjectIntoCacheWithRuntimeCheck(objHash: SHA256Hash): Promise<T>

  Same as queryOrLoadObjectIntoCache, except that it does a runtime check on $type$ field.

  The runtime check is done against the values passed inthe constructor. If the runtime check fails the promise will reject.

  Parameters

  • objHash: SHA256Hash

  Returns Promise<T>

shutdown

• shutdown(): void

  Cleanup the instance.

  After this function is called this class cannot be reused.

  Returns void