0.8.0 • Published 10 months ago

saizeriya v0.8.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

saizeriya

npm version build codecov License

Overview

サイゼリヤのメニューを取得する Node.js ライブラリ

Notes

インストール

npm install saizeriya

使用方法

import { Saizeriya } from "saizeriya";

const saizeriya = new Saizeriya();

// 全てのメニューを取得
const menus = saizeriya.all();

// 条件を指定してメニューを取得
const filteredMenus = saizeriya.all({
  priceMin: 500,
  genres: ["パスタ"],
});

// カテゴリを取得
const categories = saizeriya.categories();

// ジャンルを取得
const genres = saizeriya.genres();

// 旧ジャンルを取得
const preGenres = saizeriya.preGenres();

// 特定のIDに対応するメニューを取得
const menu = saizeriya.getById(1);

// 特定の旧IDに対応するメニューを取得
const preMenu = saizeriya.getByPreId("DG01");

// ランダムなメニューの組み合わせを取得
const randomMenus = saizeriya.random();

メソッド

all(params?: SaizeriyaMenuParams): Menu[]

条件に合う全てのメニューの一覧を取得します。

引数

  • params(オプション): フィルタリング条件

レスポンス

  • Menu[]: メニューの配列

categories(): Category[]

全てのカテゴリを取得します。

レスポンス

  • Category[]: カテゴリの配列

genres(): Genre[]

全てのジャンルを取得します。

レスポンス

  • Genre[]: ジャンルの配列

getById(id: number): Menu | undefined

指定した ID に対応するメニューを取得します。

引数

  • id: メニューの ID

レスポンス

  • Menu: メニューオブジェクト。見つからない場合はundefined

random(params?: SaizeriyaMenuParams, maxSum: number = 1000, allowDuplicates: boolean = true,): RandomMenus

指定した総額に対応するランダムなメニューの組み合わせを取得します。

引数

  • params: フィルタリングの条件
  • maxSum: 総額の上限 (デフォルト: 1000)
  • allowDuplicates: 重複許容フラグ (デフォルト: true)

レスポンス

  • RandomMenus: ランダムなメニューの組み合わせオブジェクト。

型定義

SaizeriyaMenuParams

パラメータ説明
priceMinnumber税抜価格 (最小)
priceMaxnumber税抜価格 (最大)
priceWithTaxMinnumber税込価格 (最小)
priceWithTaxMaxnumber税込価格 (最大)
categoriesstring[]カテゴリ名
namestringメニュー名
calorieMinnumberエネルギー (最小)
calorieMaxnumberエネルギー (最大)
saltMinnumber食塩相当量 (最小)
saltMaxnumber食塩相当量 (最大)
genresstring[]ジャンル名
excludedMenuIdsnumber[]除外するメニュー ID
excludeAlcoholbooleanアルコール類を除外するフラグ

Menu

フィールド説明サンプル
idnumberメニュー ID1202
namestringメニュー名小エビのサラダ
nameEnstringメニュー名(英語)Shrimp Salad
nameZhstringメニュー名(中国語)小甜虾沙拉
pricenumber税抜価格319
priceWithTaxnumber税込価格350
calorienumberエネルギー (カロリー) (kcal)192
saltnumber食塩相当量 (g)1.5
genreGenreジャンル名サラダ
categorystringカテゴリ名グランド
categoryEnstringカテゴリ名(英語)Grand Menu
categoryZhstringカテゴリ名(中国語)
isAlcoholbooleanアルコールフラグfalse
iconstringアイコン (絵文字)🍤
preIdstring旧メニュー IDSA02

Category

フィールド説明サンプル
categorystringカテゴリ名グランド
categoryEnstringカテゴリ名(英語)Grand Menu
categoryZhstringカテゴリ名(中国語)

Genre

string: ジャンル名

RandomMenus

フィールド説明
menusMenu[]組み合わせ内のメニュー一覧
totalSaltnumber食塩相当量の総額
totalCalorienumberエネルギーの総額
totalPriceWithTaxnumber税込価格の総額

Link

License

This project is licensed under the MIT License - see the LICENSE file for details.

0.8.0

10 months ago

0.7.0

10 months ago

0.6.0

10 months ago

0.5.0

11 months ago

0.4.0

11 months ago

0.3.1

11 months ago

0.3.0

11 months ago

0.2.1

11 months ago

0.2.0

11 months ago

0.1.0

11 months ago

0.0.0

11 months ago