Class CloudFlareService

Behaviors associated with CloudFlare. For example, creating, updating and deleting DNS records.

Constructors

constructor

Methods

createEntry deleteEntry getDNSEntries getZoneForEntry getZones initialize mapDNSEntries updateEntry

Constructors

constructor

Methods

createEntry

  • createEntry(entry: ARecord | CNAMERecord | MXRecord | NSRecord): Promise<void>

  • Creates an Entry in CloudFlare

    Parameters

    • entry: ARecord | CNAMERecord | MXRecord | NSRecord

      The entry to create

    Returns Promise<void>

    Throws

    if CloudFlare errors creating the entry

deleteEntry

  • deleteEntry(recordId: string, zoneId: string): Promise<void>

  • Deletes an entry in CloudFlare

    Parameters

    • recordId: string

      Record id to be deleted

    • zoneId: string

      Zone the record belongs to

    Returns Promise<void>

    Throws

    if CloudFlare errors deleteing the entry

getDNSEntries

  • getDNSEntries(zoneId: string): Promise<Record[]>

  • For the given zone, fetches the DNS entries from CloudFlare

    Parameters

    • zoneId: string

      Zone to fetch entries for

    Returns Promise<Record[]>

    A promise which resolves to the records in the zone

    Throws

    If service isn't initialized.

    Throws

    If CloudFlare errors fetching DNS records.

getZoneForEntry

  • getZoneForEntry(
        zones: Zone[],
        entry: DnsbaseEntry,
    ): { isSuccessful: boolean; zone?: Zone }

  • Given an array of CloudFlare Zones and a business object representing a DNS Entry. Determines which zone if any the entry belongs to.

    It does this by comparing the domain name suffix in the name of the entry to the zones.

    Will warn if no match is found.

    Parameters

    • zones: Zone[]

      List of zones to determine if the entry belong to

    • entry: DnsbaseEntry

      The entry to find the zone for

    Returns { isSuccessful: boolean; zone?: Zone }

    An object determining if the operation was successful. If it was, it also includes the result.

getZones

  • getZones(): Promise<Zone[]>

  • Fetches from CloudFlare all the zones that can be read

    Returns Promise<Zone[]>

    Promise which resolves to all the accessible CloudFlare Zones

initialize

  • initialize(): void

  • Initializes the service. Required before calling any public methods that interact with CloudFlare directly.

    Configures CloudFlare.

    Returns void

    Throws

    if already initialized when called.

mapDNSEntries

  • mapDNSEntries(zoneId: string, entries: Record[]): ICloudFlareEntry[]

  • Maps the CloudFlare DNS Records to the common DnsBaseCloudflareEntry type

    Parameters

    • zoneId: string

      ID of the CloudFlare Zone these records were loaded from

    • entries: Record[]

      DNS entries from CloudFlare

    Returns ICloudFlareEntry[]

    Entries transformed into DnsBaseCloudflareEntry entries

updateEntry

  • updateEntry(
        recordId: string,
        entry: ARecord | CNAMERecord | MXRecord | NSRecord,
    ): Promise<void>

  • Updates an entry in CloudFlare

    Parameters

    • recordId: string

      The id of the record to update

    • entry: ARecord | CNAMERecord | MXRecord | NSRecord

      The entry to be updated

    Returns Promise<void>

    Throws

    if CloudFlare errors updating the entry

Settings

Member Visibility

On This Page

Constructors
Methods