Nuxt Rollbar module

Nuxt Rollbar

用于集成 Rollbar 的 Nuxt 3 模块。

设置

# pnpm
pnpm add -D nuxt-rollbar

# npm
npm i -D nuxt-rollbar

# yarn
yarn add -D nuxt-rollbar

基本用法

将 nuxt-rollbar 添加到 Nuxt 配置的 modules 部分，并提供您的 Rollbar 服务器和/或客户端访问令牌。

// `nuxt.config.ts`
export default defineNuxtConfig({
  modules: ['nuxt-rollbar'],

  rollbar: {
    serverAccessToken: 'SERVER_ACCESS_TOKEN',
    clientAccessToken: 'CLIENT_ACCESS_TOKEN',
  },
});

完成！Rollbar 现在将在您的应用程序中运行。

配置

仅客户端

ℹ️ useRollbar 组合式将在服务器中返回 undefined。

export default defineNuxtConfig({
  modules: ['nuxt-rollbar'],

  rollbar: {
    clientAccessToken: 'CLIENT_ACCESS_TOKEN',
    mode: 'client',
    config: {
      // Rollbar configuration
    },
  },
});

仅服务器

ℹ️ useRollbar 组合式将在客户端中返回 undefined。

export default defineNuxtConfig({
  modules: ['nuxt-rollbar'],

  rollbar: {
    serverAccessToken: 'SERVER_ACCESS_TOKEN',
    mode: 'server',
    config: {
      // Rollbar configuration
    },
  },
});

服务器和客户端

export default defineNuxtConfig({
  modules: ['nuxt-rollbar'],

  rollbar: {
    serverAccessToken: 'SERVER_ACCESS_TOKEN',
    clientAccessToken: 'CLIENT_ACCESS_TOKEN',
    config: {
      // Rollbar configuration
    },
  },
});

模块选项

选项	类型	默认值	描述
`clientAccessToken`	`字符串`	`''`	Rollbar 客户端访问令牌。
`serverAccessToken`	`字符串`	`''`	Rollbar 服务器访问令牌。
`mode`	`字符串`	`'all'`	Rollbar 实例运行的环境模式。
`config`	`Rollbar.Configuration`	`null`	Rollbar 配置。

组合式

与 Nuxt 3 生态系统中的其他组合式一样，它们会自动导入，并且可以在应用程序的组件中使用。

ℹ️ 由于 Rollbar 实例在客户端和服务器环境中都可用，因此您可以在任一上下文中使用它。

`useRollbar`

如果 Rollbar 实例可用并为环境（客户端或服务器）配置，则返回 Rollbar 实例。否则，返回 undefined。

类型声明

function useRollbar(): Rollbar;

示例

const rollbar = useRollbar();

rollbar.log('Hello, world!');

此组合式是以下内容的简单别名

useNuxtApp().$rollbar;

💻 开发

克隆此存储库
使用 corepack enable 启用 Corepack
使用 pnpm install 安装依赖项
运行 pnpm run dev:prepare
使用 pnpm run dev 启动开发服务器

致谢

特别感谢

nuxt-plausible
nuxt-rollbar-module

感谢提供的灵感和基础工作。