Class WebcatDatabase

constructor

• new WebcatDatabase(
      config: {
          namespace: string;
          nonOriginCacheSize: number;
          originCacheSize: number;
      },
  ): WebcatDatabase

  Parameters

  • config: { namespace: string; nonOriginCacheSize: number; originCacheSize: number }

    • namespace: string

      A string prefix used for all persisted keys.

    • nonOriginCacheSize: number

      The number of hostnames to store in-memory in the negative origin cache.

    • originCacheSize: number

      The number of OriginState objects to cache locally.

  Returns WebcatDatabase

Readonlyenrollments

ReadonlynonOrigins

Readonlyorigins

getBlockMeta

• getBlockMeta(): Promise<BlockMeta | null>

  Reads block metadata from the database.

  Returns Promise<BlockMeta | null>

  A Promise that resolves the metadata for the most recently applied block.

getFQDNEnrollment

• getFQDNEnrollment(
      fqdn: string,
      cachePartition: CachePartition,
  ): Promise<Uint8Array<ArrayBufferLike>>

  Reads an enrollment hash from the database.

  Parameters

  • fqdn: string

    The fully-qualified domain name whose enrollment hash to read.

  • cachePartition: CachePartition

    The cache partition to use for cache lookups.

  Returns Promise<Uint8Array<ArrayBufferLike>>

  A Promise that resolves to the locally persisted enrollment hash corresponding to fqdn.

getLastChecked

• getLastChecked(): Promise<number | null>

  Reads the timestamp of the most recent enrollment update attempt.

  Returns Promise<number | null>

  A Promise that resolves to a time in milliseconds.

getLastUpdated

• getLastUpdated(): Promise<number | null>

  Reads the timestamp of the most recent successful enrollment update.

  Returns Promise<number | null>

  A Promise that resolves to a time in milliseconds.

listAllFQDNs

• listAllFQDNs(): Promise<string[]>

  Reads fully-qualified domain names of enrolled origins from the database.

  Returns Promise<string[]>

  A Promise that resolves to an array of the FQDNs whose enrollment is persisted locally.

setLastChecked

• setLastChecked(): Promise<void>

  Persists current time as the time of the latest enrollment update attempt.

  Returns Promise<void>

setLastUpdated

• setLastUpdated(): Promise<void>

  Persists the current time as the time of the latest successful enrollment update.

  Returns Promise<void>

updateList

• updateList(
      leaves: readonly (readonly [string, string])[],
      meta: BlockMeta,
  ): Promise<void>

  Updates the list of enrolled fully-qualified domain names.

  Parameters

  • leaves: readonly (readonly [string, string])[]
  • meta: BlockMeta

  Returns Promise<void>