Repository Factory (リポジトリファクトリー)

Factory は、Repository インスタンスを素早く簡単に作成するためのヘルパー関数群です。一般的なユースケースに合わせて事前に最適化された設定を提供するため、多くのユーザーにとって推奨されるエントリーポイントです。

提供されているファクトリー関数

PROMIDAS は、実行環境に応じた2つのファクトリー関数を提供しています。

個人のPCでの開発、CLIツール、データ分析スクリプトなどに最適化されています。

typescript

import { createPromidasForLocal } from '@f88/promidas';

const repository = createPromidasForLocal({
    protopediaApiToken: 'your-api-token',
});

特徴:

Webサーバー、バッチ処理、サーバーレス関数などのバックエンド環境に最適化されています。

typescript

import { createPromidasForServer } from '@f88/promidas';

// トークンは環境変数 PROTOPEDIA_API_V2_TOKEN から自動読み込み
const repository = createPromidasForServer();

特徴:

ファクトリー関数でも、ログレベルのオーバーライドなど最低限のカスタマイズは可能です。

typescript

const repository = createPromidasForLocal({
    protopediaApiToken: '...',
    logLevel: 'debug', // 詳細なログを出力したい場合
});

これ以上の詳細な設定(例:TTLの変更、カスタムロガーの使用など)が必要な場合は、Builder パターンを使用してください。