Class DefaultStore

constructor

• new DefaultStore(__namedParameters?): DefaultStore

• Parameters

  • __namedParameters: {
        shouldCache?: boolean;
    } = {}

    • OptionalshouldCache?: boolean

  Returns DefaultStore

data

shouldCache

append

• append<T>(domain, type, data): void

• Append information about a zone in the database.

  Type Parameters

  • T extends SupportedRecordType

  Parameters

  • domain: string

    The domain to append data for
  • type: T

    The record type to append
  • data: ZoneData[T]

    The data to append

  Returns void

delete

• delete<T>(domain, type?, data?): void

• Delete information about a zone in the database.

  If no type is provided, all data for the domain should be deleted. If no data is provided, all data of the given type should be deleted.

  Type Parameters

  • T extends SupportedRecordType

  Parameters

  • domain: string

    The domain to delete data from
  • Optionaltype: T

    Optional. The record type to delete
  • Optionaldata: ZoneData[T]

    Optional. The data to delete

  Returns void

emitCacheRequest

• emitCacheRequest<T>(zone, rType, records): Promise<void>

• Emit a cache request event.

  This event is emitted when the store asks any consumers to cache data.

  This event will be fired if the shouldCache option is set to true.

  Type Parameters

  • T extends SupportedRecordType

  Parameters

  • zone: string

    The zone to cache the record for
  • rType: T

    The record type to cache
  • records: ZoneData[T][]

    The records to cache

  Returns Promise<void>

get

• get<T>(domain, rType?, wildcards?): 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

  • T extends SupportedRecordType

  Parameters

  • domain: string

    The domain to get
  • OptionalrType: T

    The record type to get
  • wildcards: boolean = true

    Whether to resolve wildcard records

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

  The data for the given domain and record type, or null if no data is found

handler

• handler(req, res, next): void

• The handler for the store, used in the framework to answer queries.

  Parameters

  • req: DNSRequest
  • res: DNSResponse
  • next: NextFunction

  Returns void

set

• set<T>(domain, rType, data): void

• Set or update information about a zone in the database.

  Type Parameters

  • T extends SupportedRecordType

  Parameters

  • domain: string

    The domain to set
  • rType: T

    The record type to set
  • data: ZoneData[T] | ZoneData[T][]

    The data to set

  Returns void

toString

• toString(): string

• Serialize the store to a string. This is useful for persisting the store to disk.

  Returns string

  The serialized store

StaticfromString

• fromString(str): DefaultStore

• Deserialize a store from a string.

  Parameters

  • str: string

    The string to deserialize

  Returns DefaultStore

  The deserialized store