ConfigField

type ConfigField struct {
	Key       string
	Type      string
	Default   any
	Validator Validator
	Secret    bool
}

ModuleWithConfigSchema を通じて宣言します。

var _ goroku.ModuleWithConfigSchema = (*Weather)(nil)

func (m *Weather) ConfigSchema() []goroku.ConfigField {
	return []goroku.ConfigField{
		{Key: "units", Type: "choice", Default: "metric",
			Validator: &goroku.ChoiceValidator{PossibleValues: []string{"metric", "imperial"}}},
	}
}

フィールド

Key

モジュール名の下での保存キー。設定画面での識別子でもあり、Strings の _cfg_<key> が説明する対象でもあります。

Type

値	意味
`bool`	オン・オフ
`int`	整数
`float`	小数
`string`	自由テキスト
`choice`	固定の選択肢から1つ
`series`	値のリスト
`url`	URL
`link`	Telegram のリンク
`hidden`	保存するが表示しない

Default

利用者が何も設定していない間に返る値。Type と一致している必要があります。

Validator

不正な入力を保存前に弾きます。拒否は利用者に見えます。

Secret

true にすると、値はログで伏せられ、バックアップではプレースホルダに置き換わります。バックアップから復元しても、マーカーで上書きされずに現在の値が保たれます。

API キー、トークン、パスワードに使ってください。

バリデータ

バリデータ	オプション
`&BooleanValidator{}`
`&IntegerValidator{}`	`Minimum`/`HasMin`、`Maximum`/`HasMax`
`&FloatValidator{}`	`Minimum`/`HasMin`、`Maximum`/`HasMax`
`&StringValidator{}`	`MinLen`、`MaxLen`
`&ChoiceValidator{}`	`PossibleValues []string`
`&SeriesValidator{}`	`Item Validator`、`MinLen`/`HasMin`
`&URLValidator{}`
`&LinkValidator{}`
`&RegExpValidator{}`	`Pattern *regexp.Regexp`
`&HiddenValidator{}`	`Inner Validator`
`&TelegramIDValidator{}`
`&EmojiValidator{}`
`&EntityLikeValidator{}`
`&UnionValidator{}`	`Validators []Validator`
`&NoneTypeValidator{}`	何も受け付けない

値を読む

units := m.DB.GetString(m.Name(), "units", "metric")

変更に反応する

func (m *Weather) ConfigReady(config map[string]any) error {
	units, ok := config["units"].(string)
	if !ok {
		return fmt.Errorf("units は文字列である必要があります。実際は %T", config["units"])
	}
	m.mu.Lock()
	m.units = units
	m.mu.Unlock()
	return nil
}

起動時と、変更のたびに呼ばれます。エラーを返すと変更は拒否され、そのメッセージが利用者に表示されます。

ConfigField ​

フィールド ​

Key ​

Type ​

Default ​

Validator ​

Secret ​

バリデータ ​

値を読む ​

変更に反応する ​