Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Site

Hierarchy

  • _MergedSite
    • Site

Index

Properties

Optional errorMsg

errorMsg: string | string[]

If errorType === 'message', this message will pop up if the profile doesn't exist

errorType

errorType: string

status_code, message, or response_url

Optional errorUrl

errorUrl: string

If errorType === 'response_url', this is the url that the use will be redirected to if the profile doesn't exist

Optional headers

headers: {}

HTTP headers to send with the request if needed

Type declaration

Optional logoClass

logoClass: string

FontAwesome CSS class for the logo (for use in frontend)

Optional logoColor

logoColor: string

Optional value to be assigned to the CSS 'color' property

name

name: string

Optional noPeriod

noPeriod: string

???

Optional omit

omit: boolean

If true, skip this site

Optional prettyUrl

prettyUrl: string

Host/pretty formatted version of the site's URL

Optional regexCheck

regexCheck: string

RegEx for valid usernames on the website

Optional request_head_only

request_head_only: boolean

For errorType === 'status_code' websites -- use a GET request instead of a HEAD request

tags

tags: string[]

url

url: string

Template URL for website profile page

urlMain

urlMain: string

URL for website home page

Optional urlProbe

urlProbe: string

Alternate profile page test url for sites where profiles aren't publicly facing

username_claimed

username_claimed: string

Username that is claimed on the website

username_unclaimed

username_unclaimed: string

Username that is not claimed on the website

Generated using TypeDoc