Type alias HighSystemsOptions

Type declaration

• connectionLimit: number

  The maximum number of open, pending API connections to High Systems

  Default is 10

• connectionLimitPeriod: number

  The period length, in milliseconds, of connection limit

  Default is 1000

• errorOnConnectionLimit: boolean

  Throw an error if the connection limit is exceeded

  Default is false

• instance: string

  High Systems Instance.

  For example, if your High Systems url is: demo.highsystems.io Your instance is: demo

• proxy: false | {
      auth?: {
          password: string;
          username: string;
      };
      host: string;
      port: number;
  }

  Allows the use of a proxy for High Systems API requests

  Default is false

• userAgent: string

  Provide a custom User-Agent to help track API usage within your logs

  When used in the browser, this sets the X-User-Agent header instead as the browser will block any attempt to set a custom User-Agent

• userToken: string

  A High Systems User Token.

  If both a userToken and tempToken are defined, the tempToken will be used

  High Systems Documentation