Class RequestDetails

constructor

• new RequestDetails(surrogates: string[]): RequestDetails

  Parameters

  • surrogates: string[]

    any installed surrogates, just the domains

  Returns RequestDetails

all

allowed

blocked

surrogates

allowedFirstPartyCount

• allowedFirstPartyCount(): number

  The number of entities observed that were owned by the first party website

  Returns number

allowedFirstPartyOnly

• allowedFirstPartyOnly(): boolean

  When all the 'special' entities observed belong to the first party

  Returns boolean

allowedNonSpecialCount

• allowedNonSpecialCount(): number

  The number of entities observed that had 'non-special' requests.

  'non-special' means a request that was observed, but it was not classified as a tracker

  Returns number

allowedSpecialCount

• allowedSpecialCount(): number

  The number of entities observed that had 'special' requests.

  'special' means that a request was classified as a tracker, but we didn't block it for any given reason. Note: This list excludes 'non-special' requests such as 3rd party requests not classified as trackers

  Returns number

blockedCompanyNames

• blockedCompanyNames(): string[]

  Create a list of company names, excluding any 'unknown' ones.

  Returns string[]

blockedCount

• blockedCount(): number

  Returns number

forEachEntity

• forEachEntity(fn: (entity: AggregateCompanyData) => void): void

  Loop over every seen entity

  Parameters

  • fn: (entity: AggregateCompanyData) => void

  Returns void

matches

• matches(
      protectionsEnabled: boolean,
      states: (
          | "protectionsOn"
          | "protectionsOn_blocked"
          | "protectionsOn_blocked_allowedTrackers"
          | "protectionsOn_blocked_allowedNonTrackers"
          | "protectionsOn_blocked_allowedTrackers_allowedNonTrackers"
          | "protectionsOn_allowedTrackers"
          | "protectionsOn_allowedNonTrackers"
          | "protectionsOn_allowedTrackers_allowedNonTrackers"
          | "protectionsOn_allowedFirstParty"
          | "protectionsOn_allowedFirstParty_allowedNonTrackers"
          | "protectionsOff"
          | "protectionsOff_allowedTrackers"
          | "protectionsOff_allowedNonTrackers"
          | "protectionsOff_allowedTrackers_allowedNonTrackers"
      )[],
  ): boolean

  Parameters

  • protectionsEnabled: boolean
  • states: (
        | "protectionsOn"
        | "protectionsOn_blocked"
        | "protectionsOn_blocked_allowedTrackers"
        | "protectionsOn_blocked_allowedNonTrackers"
        | "protectionsOn_blocked_allowedTrackers_allowedNonTrackers"
        | "protectionsOn_allowedTrackers"
        | "protectionsOn_allowedNonTrackers"
        | "protectionsOn_allowedTrackers_allowedNonTrackers"
        | "protectionsOn_allowedFirstParty"
        | "protectionsOn_allowedFirstParty_allowedNonTrackers"
        | "protectionsOff"
        | "protectionsOff_allowedTrackers"
        | "protectionsOff_allowedNonTrackers"
        | "protectionsOff_allowedTrackers_allowedNonTrackers"
    )[]

  Returns boolean

state

• state(
      protectionsEnabled: boolean,
  ):
      | "protectionsOn"
      | "protectionsOn_blocked"
      | "protectionsOn_blocked_allowedTrackers"
      | "protectionsOn_blocked_allowedNonTrackers"
      | "protectionsOn_blocked_allowedTrackers_allowedNonTrackers"
      | "protectionsOn_allowedTrackers"
      | "protectionsOn_allowedNonTrackers"
      | "protectionsOn_allowedTrackers_allowedNonTrackers"
      | "protectionsOn_allowedFirstParty"
      | "protectionsOn_allowedFirstParty_allowedNonTrackers"
      | "protectionsOff"
      | "protectionsOff_allowedTrackers"
      | "protectionsOff_allowedNonTrackers"
      | "protectionsOff_allowedTrackers_allowedNonTrackers"

  From the available request data, determine the global 'state' of the Request Data

  Parameters

  • protectionsEnabled: boolean

  Returns
      | "protectionsOn"
      | "protectionsOn_blocked"
      | "protectionsOn_blocked_allowedTrackers"
      | "protectionsOn_blocked_allowedNonTrackers"
      | "protectionsOn_blocked_allowedTrackers_allowedNonTrackers"
      | "protectionsOn_allowedTrackers"
      | "protectionsOn_allowedNonTrackers"
      | "protectionsOn_allowedTrackers_allowedNonTrackers"
      | "protectionsOn_allowedFirstParty"
      | "protectionsOn_allowedFirstParty_allowedNonTrackers"
      | "protectionsOff"
      | "protectionsOff_allowedTrackers"
      | "protectionsOff_allowedNonTrackers"
      | "protectionsOff_allowedTrackers_allowedNonTrackers"