メインコンテンツまでスキップ

JS-SDK

概要​

@pocketの JS-SDK を使用すると、カスタマイズ開発、プラグイン開発を効率的に実施できます。
JS-SDKをインストールし、設定を行うことで、Visual Studio Codeで関数の補完が利用可能です。

必要な環境​

@at-pocket/js-sdk を使用するには、Node.js が必要です。最低限 ESModule をサポートするバージョン（v12.0.0 以降）をインストールしてください。

node -v

最新の Node.js は公式サイト（https://nodejs.org/）からダウンロードできます。

インストール​

  1. 下記コマンドでnpmパッケージをインストールします。
npm i -D @at-pocket/js-sdk
  1. フォルダに以下の内容でjsconfig.jsonを作成します。
{
  "compilerOptions": {
    "checkJs": true,
    "allowJs": true,
    "typeRoots": [
      "node_modules/@at-pocket"
    ]
  }
}

使用方法​

JavaScriptファイル内で、atPocketと入力するとカスタマイズ開発、プラグイン開発で使用できる@pocketの関数の補完が行えます。