nuxt-rollbar

一个集成 Rollbar 的 Nuxt 3 模块。

Nuxt Rollbar module

Nuxt Rollbar

Nuxt 3 模块，用于集成 Rollbar。

设置

# 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`	`string`	`''`	Rollbar 客户端访问令牌。
`serverAccessToken`	`string`	`''`	Rollbar 服务器访问令牌。
`模式`	`string`	`'all'`	您的 Rollbar 实例运行的环境模式。
`config`	`Rollbar.Configuration`	`null`	Rollbar 配置。

可组合项

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

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

`useRollbar`

如果 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

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