Class UserAgentClass

Web request user agent class.

Index

Constructors

constructor

Methods

get set useDefault

Constructors

constructor

new UserAgentClass(): UserAgentClass
Returns UserAgentClass

Methods

get

get(): string
Get the user agent.

Returns string
- Defined in classes/user-agent.ts:12

set

set(value): void
Set the user agent.
Parameters
- value: string
  User agent to set.
Returns void
- Defined in classes/user-agent.ts:20

useDefault

useDefault(pathOverride?): void
Set the user agent to the default. Will error if sxcu.api's package.json is not present.
Parameters
- OptionalpathOverride: string
  
  A path to a package.json to use instead of sxcu.api's package.json. The package.json needs to include name, version, and homepage.
Returns void
- Defined in classes/user-agent.ts:29