Class TargetModel

constructor

• new TargetModel(
      campaignId: string,
      targetId: string,
      accessLevel: "transparent" | "landing",
      donorSecure: boolean,
      donorSub: string,
      donorDomain: string,
      donorPort: number,
      mirrorSecure: boolean,
      mirrorSub: string,
      mirrorDomain: string,
      mirrorPort: number,
      isEnabled: boolean,
      messageCount: number,
      createdAt: Date,
  ): TargetModel

  Creates a new target model instance.

  Parameters

  • campaignId: string

    The ID of the campaign this target belongs to

  • targetId: string

    The unique identifier of the target

  • accessLevel: "transparent" | "landing"

    The access level

  • donorSecure: boolean

    Whether the donor server uses HTTPS

  • donorSub: string

    The donor subdomain

  • donorDomain: string

    The donor domain name

  • donorPort: number

    The donor server port

  • mirrorSecure: boolean

    Whether the mirror uses HTTPS

  • mirrorSub: string

    The mirror subdomain

  • mirrorDomain: string

    The mirror domain

  • mirrorPort: number

    The mirror server port

  • isEnabled: boolean

    Whether the target is currently enabled

  • messageCount: number

    Total number of messages processed for this target

  • createdAt: Date

    The date and time when the target was created

  Returns TargetModel

ReadonlyaccessLevel

ReadonlycampaignId

ReadonlycreatedAt

ReadonlydonorDomain

ReadonlydonorPort

ReadonlydonorSecure

ReadonlydonorSub

ReadonlyisEnabled

ReadonlymessageCount

ReadonlymirrorDomain

ReadonlymirrorPort

ReadonlymirrorSecure

ReadonlymirrorSub

ReadonlytargetId

donorHost

• get donorHost(): string

  Returns the donor host.

  Returns string

donorHostname

• get donorHostname(): string

  Returns the full donor hostname.

  Returns string

donorProtocol

• get donorProtocol(): string

  Returns the donor protocol.

  Returns string

donorUrl

• get donorUrl(): string

  Returns the full donor URL.

  Returns string

mirrorHost

• get mirrorHost(): string

  Returns the mirror host.

  Returns string

mirrorHostname

• get mirrorHostname(): string

  Returns the full mirror hostname.

  Returns string

mirrorProtocol

• get mirrorProtocol(): string

  Returns the mirror protocol.

  Returns string

mirrorUrl

• get mirrorUrl(): string

  Returns the full mirror URL.

  Returns string

StaticisEnabled

• isEnabled<T extends TargetModel>(model: T): model is T & { isEnabled: true }

  Type guard to check if a target is enabled.

  Type Parameters

  • T extends TargetModel

  Parameters

  • model: T

    The target model to check

  Returns model is T & { isEnabled: true }

  true if the target is enabled, false otherwise

StaticisNotNull

• isNotNull<T extends TargetModel>(model: T | null): model is T

  Type guard to filter out null values in arrays.

  Type Parameters

  • T extends TargetModel

  Parameters

  • model: T | null

    The model to check

  Returns model is T

  true if the model is not null, false otherwise