BoothMate API Documentation - v0.4.0
    Preparing search index...

    Class BoothMate

    Index

    Constructors

    • BoothMateのインスタンスを作成します。

      認証に必要なトークンやオプションを設定してBooth.pmのAPIにアクセスできるようにします。

      Parameters

      • options: BoothMateOptions = {}

        トークンやデバッグオプションを含む設定オブジェクト

      Returns BoothMate

      import 'dotenv/config';
      import { BoothMate } from 'boothmate';

      const client = new BoothMate({
      sessionToken: process.env.SESSION_TOKEN!,
      csrfToken: process.env.CSRF_TOKEN!,
      });

      // もしくはトークンを省略して初期化も可能です
      // const client = new BoothMate();

      await client.item.search('VRChat');

    Properties

    商品の検索・取得を行うサービスクラスです。

    ショップの情報を取得するサービスクラスです。

    wishlist: WishlistService

    スキリストの取得・操作を行うサービスクラスです。

    ユーティリティ関数を提供するサービスクラスです。

    notification: NotificationService

    通知の取得を行うサービスクラスです。 実験的な機能であり、将来的に変更される可能性があります。

    Methods

    • トークンやオプションを更新します。

      Parameters

      • options: BoothMateOptions

        トークンやデバッグオプションを含む設定オブジェクト

      Returns void

      // セッションの変更
      client.setOptions({
      sessionToken: process.env.SESSION_TOKEN!,
      csrfToken: process.env.CSRF_TOKEN!,
      });

      // セッションのクリア
      client.setOptions({});