Class Server

Hierarchy

Constructors

constructor

Properties

apiKey? port

Methods

#generate email phone start

Constructors

constructor

  • Parameters

    • main: {
          email: string;
          options: {
              clientId: string;
              clientSecret: string;
              refreshToken: string;
              username?: string;
          };
      }
      • email: string
      • options: {
            clientId: string;
            clientSecret: string;
            refreshToken: string;
            username?: string;
        }
        • clientId: string
        • clientSecret: string
        • refreshToken: string
        • Optional username?: string
    • Optional apiKey: string
    • port: number = 4040
    • Optional debug: boolean

    Returns Server

Properties

Private Optional apiKey

apiKey?: string

Private port

port: number = 4040

Methods

Private #generate

  • #generate(length?, options?): null | string

  • Parameters

    • length: number = 10
    • options: {
          lowerLetters?: boolean;
          numbers?: boolean;
          symbols?: boolean;
          upperLetters?: boolean;
      } = {}
      • Optional lowerLetters?: boolean
      • Optional numbers?: boolean
      • Optional symbols?: boolean
      • Optional upperLetters?: boolean

    Returns null | string

email

  • Parameters

    • emails: string | string[]
    • options: {
          html?: string;
          subject?: string;
          text?: string;
      }
      • Optional html?: string
      • Optional subject?: string
      • Optional text?: string

    Returns Promise<SentMessageInfo>

phone

  • Parameters

    • number: string
    • text: string
    • region: "us" | "canada" | "intl" = "us"
    • Optional carrier: "uscellular" | "sprint" | "cellone" | "telus" | "alaskacommunications" | "rogers" | "cricket" | "nex-tech" | "tmobile" | "att" | "westernwireless" | "freedommobile" | "verizon" | "republic" | "bluskyfrog" | "loopmobile" | "clearlydigital" | "comcast" | "corrwireless" | "cellularsouth" | "centennialwireless" | "carolinawestwireless" | "southwesternbell" | "fido" | "ideacellular" | "indianapaging" | "illinoisvalleycellular" | "alltel" | "centurytel" | "dobson" | "surewestcommunications" | "mobilcomm" | "clearnet" | "koodomobile" | "metrocall2way" | "boostmobile" | "onlinebeep" | "metrocall" | "mci" | "ameritechpaging" | "pcsone" | "qwest" | "satellink" | "threeriverwireless" | "bluegrasscellular" | "edgewireless" | "goldentelecom" | "publicservicecellular" | "westcentralwireless" | "houstoncellular" | "mts" | "suncom" | "bellmobilitycanada" | "northerntelmobility" | "uswest" | "unicel" | "virginmobilecanada" | "virginmobile" | "airtelchennai" | "kolkataairtel" | "delhiairtel" | "tsrwireless" | "swisscom" | "mumbaibplmobile" | "vodafonejapan" | "gujaratcelforce" | "movistar" | "delhihutch" | "digitextjamacian" | "jsmtelepage" | "escotel" | "sunrisecommunications" | "teliadenmark" | "itelcel" | "mobileone" | "m1bermuda" | "o2mmail" | "telenor" | "mobistarbelgium" | "mobtelsrbija" | "telefonicamovistar" | "nextelmexico" | "globalstar" | "iridiumsatellitecommunications" | "oskar" | "meteor" | "smarttelecom" | "sunrisemobile" | "o2" | "oneconnectaustria" | "optusmobile" | "mobilfone" | "southernlinc" | "teletouch" | "vessotel" | "ntelos" | "rek2" | "chennairpgcellular" | "safaricom" | "satelindogsm" | "scs900" | "sfrfrance" | "mobiteltanzania" | "comviq" | "emt" | "geldentelecom" | "pandtluxembourg" | "netcom" | "primtel" | "tmobileaustria" | "tele2lativa" | "umc" | "uraltel" | "vodafoneitaly" | "lmt" | "tmobilegermany" | "dttmobile" | "tmobileuk" | "simplefreedom" | "tim" | "vodafone" | "wyndtell" | "projectfi"

    Returns Promise<unknown[]>

start

  • Returns Express

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc