rollbar
nuxt-rollbar

Rollbarを統合するためのNuxt 3モジュール。

Nuxt Rollbar module

Nuxt Rollbar

npm version

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文字列''Rollbarクライアントアクセストークン。
serverAccessToken文字列''Rollbarサーバーアクセストークン。
モード文字列'all'Rollbarインスタンスが実行される環境モード。
configRollbar.ConfigurationnullRollbar構成。

コンポーザブル

Nuxt 3エコシステムの他のコンポーザブルと同様に、これらは自動インポートされ、アプリケーションのコンポーネントで使用できます。

ℹ️ Rollbarインスタンスはクライアントとサーバーの両方の環境で利用できるため、どちらのコンテキストでも使用できます。

useRollbar

Rollbarインスタンスが利用可能で、環境(クライアントまたはサーバー)用に構成されている場合はそれを返します。それ以外の場合は、undefinedを返します。

型宣言

function useRollbar(): Rollbar;

const rollbar = useRollbar();

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

このコンポーザブルは単純なエイリアスです。

useNuxtApp().$rollbar;

💻 開発

  1. このリポジトリをクローンする
  2. corepack enable を使用して Corepack を有効にする
  3. pnpm installを使用して依存関係をインストールする
  4. pnpm run dev:prepare を実行します。
  5. pnpm run dev を使用して開発サーバーを起動します。

感謝

特に感謝

インスピレーションと基礎作業に感謝します。

ライセンス

MITライセンス © 2023 Jairo Blatt