Narcissistic Piano Mover

    @appsignal/plugin-breadcrumbs-network
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.21 • Public • Published

    @appsignal/plugin-breadcrumbs-network

    The @appsignal/javascript plugin for automatically adding a breadcrumb on every network request. Works with both XMLHttpRequest and fetch.

    Installation

    Add the @appsignal/plugin-breadcrumbs-network and @appsignal/javascript packages to your package.json. Then, run yarn install/npm install.

    You can also add these packages to your package.json on the command line:

    yarn add @appsignal/javascript @appsignal/plugin-breadcrumbs-network
    npm install --save @appsignal/javascript @appsignal/plugin-breadcrumbs-network
    

    Usage

    import Appsignal from "@appsignal/javascript"
    import { plugin } from "@appsignal/plugin-breadcrumbs-network"
    
    const appsignal = new Appsignal({ 
      key: "YOUR FRONTEND API KEY"
    })
    
    appsignal.use(plugin(options))

    plugin options

    The plugin can be initialized with the following options:

    Param Type Description
    xhrEnabled Boolean (optional) A boolean value representing whether the plugin should bind to XMLHttpRequest. Defaults to true.
    fetchEnabled Boolean (optional) A boolean value representing whether the plugin should bind to fetch. Defaults to true.

    Development

    Installation

    This repository is a Lerna-managed monorepo, containing packages (located in the /packages directory) that map to separate npm modules.

    To install the dependencies:

    yarn install
    lerna bootstrap

    You can then run the following to start the compiler in watch mode. This automatically compiles both the ES Module and CommonJS variants:

    yarn build:watch

    You can also build the library without watching the directory:

    yarn build        # build both CJS and ESM
    yarn build:cjs    # just CJS
    yarn build:esm    # just ESM
    

    Testing

    The tests for this library use Jest as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:

    yarn test

    Versioning

    This repo uses Semantic Versioning (often referred to as semver). Each package in the repository is versioned independently from one another.

    @TODO: define how this works once we know more about releasing

    Contributing

    Thinking of contributing to this repo? Awesome! 🚀

    Please follow our Contributing guide in our documentation and follow our Code of Conduct.

    Also, we would be very happy to send you Stroopwafles. Have look at everyone we send a package to so far on our Stroopwafles page.

    Support

    Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.

    Keywords

    none

    Install

    npm i @appsignal/plugin-breadcrumbs-network

    DownloadsWeekly Downloads

    5,017

    Version

    1.1.21

    License

    MIT

    Unpacked Size

    29.8 kB

    Total Files

    16

    Last publish

    Collaborators

    • as_unflxw
    • luismiramirez
    • matsimitsu
    • wesoudshoorn
    • jvanbaarsen
    • thijsc
    • tombruijn
    • jkreeftmeijer