![Nuxt Rollbar module](https://github.com/jairoblatt/nuxt-rollbar/raw/HEAD/./.github/og.png)
Nuxt Rollbar
![npm version](https://img.shields.io/npm/v/nuxt-rollbar?color=a1b858&label=)
Nuxt 3 module to integrate Rollbar.
Setup
pnpm add -D nuxt-rollbar
npm i -D nuxt-rollbar
yarn add -D nuxt-rollbar
Basic Usage
Add nuxt-rollbar
to the modules
section of your Nuxt configuration and provide your Rollbar server and/or client access token(s).
export default defineNuxtConfig({
modules: ['nuxt-rollbar'],
rollbar: {
serverAccessToken: 'SERVER_ACCESS_TOKEN',
clientAccessToken: 'CLIENT_ACCESS_TOKEN',
},
});
Done! Rollbar will now run in your application.
Configuration
Client Only
ℹ️ useRollbar
composable will return undefined
in the server.
export default defineNuxtConfig({
modules: ['nuxt-rollbar'],
rollbar: {
clientAccessToken: 'CLIENT_ACCESS_TOKEN',
mode: 'client',
config: {
},
},
});
Server Only
ℹ️ useRollbar
composable will return undefined
in the client.
export default defineNuxtConfig({
modules: ['nuxt-rollbar'],
rollbar: {
serverAccessToken: 'SERVER_ACCESS_TOKEN',
mode: 'server',
config: {
},
},
});
Both server and client
export default defineNuxtConfig({
modules: ['nuxt-rollbar'],
rollbar: {
serverAccessToken: 'SERVER_ACCESS_TOKEN',
clientAccessToken: 'CLIENT_ACCESS_TOKEN',
config: {
},
},
});
Module Options
Option | Type | Default | Description |
---|
clientAccessToken | string | '' | Rollbar client access token. |
serverAccessToken | string | '' | Rollbar server access token. |
mode | string | 'all' | Environment mode in which your Rollbar instance runs. |
config | Rollbar.Configuration | null | Rollbar configuration. |
Composables
As with other composables in the Nuxt 3 ecosystem, they are auto-imported and can be used in your application's components.
ℹ️ Since the Rollbar instance is available in both the client and server environments, you can use it in either context.
useRollbar
Return the Rollbar instance if it is available and configured for the environment (client or server). Otherwise, return undefined
.
Type Declarations
function useRollbar(): Rollbar;
Example
const rollbar = useRollbar();
rollbar.log('Hello, world!');
This composable is a simple alias for
useNuxtApp().$rollbar;
💻 Development
- Clone this repository
- Enable Corepack using
corepack enable
- Install dependencies using
pnpm install
- Run
pnpm run dev:prepare
- Start development server using
pnpm run dev
Thanks
Special thanks to:
Appreciate the inspiration and groundwork provided.
License
MIT License © 2023 Jairo Blatt