Class StoreAbstract

A store is a database that stores information about zones.

Stores can take any form, from a simple in-memory store to a store that persists data to disk. They don't necessarily need to have any formal database backing them, but they should be able to deterministically store and retrieve data and resolve wildcard records.

Hierarchy

  • EventEmitter
    • Store

Implemented by

Constructors

constructor

Properties

handler

Methods

append delete get set

Constructors

constructor

  • new Store(options?): Store

  • Parameters

    • Optionaloptions: EventEmitterOptions

    Returns Store

Properties

Abstracthandler

handler: Handler

Methods

Abstractappend

  • append<T>(zone, rType, data): Awaitable<void>

  • Append information about a zone in the database.

    Type Parameters

    Parameters

    • zone: string

      The name of the zone to append

    • rType: T

      The record type to append

    • data: ZoneData[T]

      The data to append

    Returns Awaitable<void>

Abstractdelete

  • delete<T>(zone, rType?, rData?): Awaitable<void>

  • Delete information about a zone in the database.

    Type Parameters

    Parameters

    • zone: string

      the zone to delete

    • OptionalrType: T

      the record type to delete. If not provided, all records in the zone should be deleted.

    • OptionalrData: ZoneData[T]

    Returns Awaitable<void>

Abstractget

  • get<T>(zone, rType?): Awaitable<null | (
        | CaaData
        | DnskeyData
        | DsData
        | HInfoData
        | MxData
        | NaptrData
        | NsecData
        | Nsec3Data
        | RpData
        | RrsigData
        | SrvData
        | SoaData
        | SshfpData
        | TlsaData
        | TxtData)[] | ZoneData[T][]>

  • Retrieve information about a zone in the database.

    Type Parameters

    Parameters

    • zone: string

      The name of the zone to retrieve

    • OptionalrType: T

      The record type to retrieve. If not provided, all records in the zone should be retrieved.

    Returns Awaitable<null | (
        | CaaData
        | DnskeyData
        | DsData
        | HInfoData
        | MxData
        | NaptrData
        | NsecData
        | Nsec3Data
        | RpData
        | RrsigData
        | SrvData
        | SoaData
        | SshfpData
        | TlsaData
        | TxtData)[] | ZoneData[T][]>

Abstractset

Settings

Member Visibility

On This Page

Constructors
Properties
Methods