Skip to content

Documentation/Type definitions for Browser Agent configuration API options #1325

Closed
@alexUXUI

Description

@alexUXUI

Summary

As a user of Browser Agent, I would like to have reference material for the Browser Agent configuration options in a format that is low effort for engineers to access.

Currently, there is tons of great documentation in the form of guides and tutorials here: https://docs.newrelic.com/docs/browser/new-relic-browser/configuration/browser-app-settings-page/

However, despite my best faith attempts, I cannot seem to find an API definition, declaring all the configuration options available to me.

Lastly, I came to the source code, and I cannot find type definitions.

Desired Behavior

There is a place that says what the configuration options for Browser Agent are and I can access this place through the documentation website, or intellisense, or NPM docs.

Possible Solution

  1. API section in docs website
  2. Type Definitions shipped with NPM package
  3. Docs shipped with NPM package

Additional context

This all started when I wanted to figure out if there was some way I could give a browser agent a name of unique ID of sorts so that we can partition based on env.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions