npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@shopify/react-bugsnag

v4.1.0

Published

An opinionated wrapper for Bugsnag's React plugin

Downloads

28,889

Readme

@shopify/react-bugsnag

Build Status Build Status License: MIT npm version npm bundle size (minified + gzip)

An opinionated wrapper for Bugsnag's React plugin with smart defaults and support for universal server-side-rendered applications.

Installation

yarn add @shopify/react-bugsnag

QuickStart

  • Create a new project on bugsnag and get your API key
const API_KEY = 'api-key-from-bugsnag';
  • Create a bugsnag client instance
import {createBugsnagClient} from '@shopify/react-bugsnag';

const API_KEY = 'api-key-from-bugsnag';
const client = createBugsnagClient({apiKey: API_KEY});
  • Wrap your React tree with the <Bugsnag /> component
import React from 'react';
import {createBugsnagClient, Bugsnag} from '@shopify/react-bugsnag';

const API_KEY = 'api-key-from-bugsnag';
const client = createBugsnagClient({apiKey: API_KEY});

function App() {
  return <Bugsnag client={client}>{/* app code */}</Bugsnag>;
}

Your application should now report runtime errors in the production and staging environments to bugsnag. You are also now able to use useErrorLogger anywhere in your application tree in order to manually log to bugsnag.

API

Bugsnag

<Bugsnag client={client} />

The primary API for this library, the <Bugsnag /> component handles rendering @bugsnag/react-plugin's provider intelligently when the plugin is present on the given client. It also automatically omits the <ErrorBoundary /> when used during Server-Side-Rendering as it relies on DOM globals and would otherwise break. The <Bugsnag /> component also renders a ErrorLoggerContext.Provider with the given client as the value.

note: This component does not care how the client index was created, whether via the default APIs from @bugsnag/js or using the defaults provided by this package's createBugsnagClient function.

createBugsnagClient

createBugsnagClient({apiKey: 'some-key'});

Creates a bugsnag client and passes it a number of sane default configuration options. It must be passed an apiKeybut all other configutation is optional.

The default configuration options are equivalent to:

  releaseStage: process.env.NODE_ENV,
  autoTrackSessions: false,
  enabledReleaseStages: ['production', 'staging'],
  maxBreadcrumbs: 40,
  plugins: [new ReactPlugin()],

useErrorLogger

const logger = useErrorLogger();
logger.notify(new Error('manually notifying'));

This API provides a way for any component to manually notify. This is ideal for flows such as fetch requests where the error may be handled in the code but you wish to send an error to bugsnag regardless.