Class QueueStorageAdapter<T>Abstract

constructor

• new QueueStorageAdapter<T extends QueueJson = QueueJson>(): QueueStorageAdapter<
      T,
  >

  Type Parameters

  • T extends QueueJson = QueueJson

  Returns QueueStorageAdapter<T>

namespace

"hoshimiqueue"
Copy

console.log(storage.namespace); // "hoshimiqueue"
Copy

AbstractbuildKey

• buildKey(...parts: RestOrArray<string>): string

  Build a key from the given parts.

  Parameters

  • ...parts: RestOrArray<string>

    The parts to build the key from.

  Returns string

  The built key.

  Example

  const key = storage.buildKey("part1", "part2", "part3");
  Copy

Abstractclear

• clear(): Awaitable<void>

  Clear the storage.

  Returns Awaitable<void>

  Scary, right?

  Example

  await storage.clear();
  Copy

Abstractdelete

• delete(key: string): Awaitable<boolean>

  Delete the value using the key.

  Parameters

  • key: string

    The key to delete the value from.

  Returns Awaitable<boolean>

  Returns true if the key was deleted.

  Example

  const success = await storage.delete("key");
  console.log(success); // true
  Copy

Abstractget

• get(key: string): Awaitable<T | undefined>

  Get the value using the key.

  Parameters

  • key: string

    The key to get the value from.

  Returns Awaitable<T | undefined>

  The value of the key.

  Example

  const value = await storage.get("key");
  console.log(value); // "value"
  Copy

Abstracthas

• has(key: string): Awaitable<boolean>

  Check if the storage has the key.

  Parameters

  • key: string

    The key to check.

  Returns Awaitable<boolean>

  Return true if the key exists.

  Example

  const exists = await storage.has("key");
  console.log(exists); // true
  Copy

Abstractparse

• parse(value: unknown): Awaitable<T>

  Parse the value.

  Parameters

  • value: unknown

    The value to parse.

  Returns Awaitable<T>

  The parsed value.

  Example

  const parsed = await storage.parse<{ key: string }>("{'key':'value'}");
  console.log(parsed); // { key: "value" }
  Copy

Abstractset

• set(key: string, value: T): Awaitable<void>

  Set the value using the key.

  Parameters

  • key: string

    The key to set the value to.

  • value: T

    The value to set.

  Returns Awaitable<void>

  Did you know this can be async?

  Example

  await storage.set("key", "value");
  Copy

Abstractstringify

• stringify<R = string>(value: unknown): Awaitable<R>

  Stringify the value.

  Type Parameters

  • R = string

  Parameters

  • value: unknown

    The value to stringify.

  Returns Awaitable<R>

  The stringified value.

  Example

  const stringified = await storage.stringify({ key: "value" });
  console.log(stringified); // "{'key':'value'}"
  Copy