Naval Pilgrim's Mayflower

    @exceptionless/browser
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    Exceptionless Browser

    This package provides native JavaScript support for applications that are built in vanilla HTML and JS.

    Getting Started

    To use this package, your must be using ES6 and support ESM modules.

    Installation

    You can install Exceptionless either in your browser application using a script tag, or you can use the Node Package Manager (npm) to install the package.

    CDN

    Add the following script tag at the very beginning of your page:

    <script type="module">
    import { Exceptionless } from "https://unpkg.com/@exceptionless/browser";
    
    await Exceptionless.startup((c) => {
    c.apiKey = "API_KEY_HERE";
    });
    </script>

    npm

    1. Install the package by running npm install @exceptionless/browser --save.
    2. Import Exceptionless and call startup during app startup.
    import { Exceptionless } from "@exceptionless/browser";
    
    await Exceptionless.startup((c) => {
      c.apiKey = "API_KEY_HERE";
    });

    Configuration

    While your app is starting up, you should call startup on the Exceptionless client. This ensures the client is configured and automatic capturing of unhandled errors occurs.

    import { Exceptionless } from "@exceptionless/browser";
    
    await Exceptionless.startup(c => {
      c.apiKey = "API_KEY_HERE";
      c.setUserIdentity("12345678", "Blake");
    
      // set some default data
      c.defaultData["mydata"] = {
        myGreeting: "Hello World"
      };
    
      c.defaultTags.push("Example", "JavaScript", "Browser");
    });

    Once that's done, you can use the Exceptionless client anywhere in your app by importing Exceptionless followed by the method you want to use. For example:

    await Exceptionless.submitLog("Hello world!");

    Please see the docs for more information on configuring the client.

    Support

    If you need help, please contact us via in-app support, open an issue or join our chat on Discord. We’re always here to help if you have any questions!

    Install

    npm i @exceptionless/browser

    DownloadsWeekly Downloads

    144

    Version

    2.0.0

    License

    Apache-2.0

    Unpacked Size

    631 kB

    Total Files

    44

    Last publish

    Collaborators

    • exceptionless