Handlebars ヘルパーリファレンス

Restorm の 式 はすべて Handlebars テンプレートです。URL、ヘッダー、 パラメーター、リクエストボディ、Expression 型の環境変数、シナリオのフィールド、 Transform template アクションのテンプレートが対象です。

このページでは 116 個の名前付きヘルパー と 22 個の動的変数 を一覧にします。

Ctrl+Space で、対応しているフィールドの自動補完が起動します。

変数はヘルパーより優先されます

同じ名前が変数としてもヘルパーとしても存在する場合、引数なし の {{min}} は変数を読み、引数つき の {{min a b}} はヘルパーを呼びます。 サブ式 (min a b) は常にヘルパーを呼びます。

なお、テンプレートは HTML エスケープなし でコンパイルされます。 値に含まれる & や < はそのまま通ります。JSON や XML ではこれが望ましい 挙動です。

比較（15）

ヘルパー	シグネチャ	効果
eq	{{eq a b}}	a === b
ne	{{ne a b}}	a !== b
neq	{{neq a b}}	ne のエイリアス
lt	{{lt a b}}	a < b（数値比較）
lte	{{lte a b}}	a <= b
gt	{{gt a b}}	a > b
gte	{{gte a b}}	a >= b
and	{{#and a b}}…{{else}}…{{/and}}	ブロック：すべての引数が真
or	{{#or a b}}…{{/or}}	ブロック：少なくとも 1 つの引数が真
not	{{not value}}	否定
ifEquals	{{#ifEquals a b}}…{{else}}…{{/ifEquals}}	ブロック、厳密等価
is	{{#is a b}}…{{/is}}	ブロック、文字列としての比較
isnt	{{#isnt a b}}…{{/isnt}}	ブロック、文字列としての不一致
default	{{default value fallback}}	value が定義されていればそれ、なければ fallback
compare	{{#compare a "op" b}}…{{/compare}}	ブロック。op ∈ == === != !== < <= > >=

{{default region "eu-west-1"}}
{{#compare quantite ">" 100}}gros{{else}}normal{{/compare}}

文字列（37）

ヘルパー	シグネチャ	例 → 結果
lowercase	{{lowercase s}}	Bonjour → bonjour
uppercase	{{uppercase s}}	Bonjour → BONJOUR
capitalize	{{capitalize s}}	bonjour tout → Bonjour tout
capitalizeAll	{{capitalizeAll s}}	bonjour tout → Bonjour Tout
titleize	{{titleize s}}	capitalizeAll と同じ
camelcase	{{camelcase s}}	mon-champ → monChamp
pascalcase	{{pascalcase s}}	mon-champ → MonChamp
snakecase	{{snakecase s}}	monChamp → mon_champ
snakeCase	{{snakeCase s}}	snakecase のエイリアス
dashcase	{{dashcase s}}	monChamp → mon-champ
dotcase	{{dotcase s}}	monChamp → mon.champ
pathcase	{{pathcase s}}	monChamp → mon/champ
sentencecase	{{sentencecase s}}	BONJOUR TOUT → Bonjour tout
slugify	{{slugify s}}	Mon Beau Titre ! → mon-beau-titre
trim	{{trim s}}	前後の空白を削除
trimLeft	{{trimLeft s}}	左側のみ
trimRight	{{trimRight s}}	右側のみ
replace	{{replace s search replacement}}	すべての 出現を置換（リテラル、正規表現ではありません）
split	{{split s separator}}	配列に分割。区切りは既定で ,
truncate	{{truncate s length suffix}}	既定は長さ 50、接尾辞 ...
ellipsis	{{ellipsis s length}}	truncate と同様で、接尾辞は …
append	{{append s suffix}}	末尾に連結
prepend	{{prepend s prefix}}	先頭に連結
reverse	{{reverse value}}	文字列 または 配列を反転
startsWith	{{#startsWith s prefix}}…{{/startsWith}}	ブロック
endsWith	{{#endsWith s suffix}}…{{/endsWith}}	ブロック
contains	{{#contains sOrArray value}}…{{/contains}}	ブロック
match	{{match s pattern}}	すべての一致、または null
test	{{#test s pattern}}…{{/test}}	ブロック、正規表現によるテスト
padStart	{{padStart s length char}}	左側を埋める
padEnd	{{padEnd s length char}}	右側を埋める
repeat	{{repeat s n}}	繰り返す
substring	{{substring s start end}}	部分文字列を取り出す
indexOf	{{indexOf s search}}	位置、なければ -1
count	{{count s substr}}	出現回数
newLineToBr	{{newLineToBr s}}	\n → <br>
stripTags	{{stripTags s}}	<…> タグを削除

{{slugify nomProduit}}
{{padStart numeroCommande 8 "0"}}
{{truncate description 120}}

数値演算（19）

ヘルパー	シグネチャ	効果
add	{{add a b}}	和
subtract	{{subtract a b}}	差
multiply	{{multiply a b}}	積
divide	{{divide a b}}	商
modulo	{{modulo a b}}	剰余
abs	{{abs a}}	絶対値
ceil	{{ceil a}}	切り上げ
floor	{{floor a}}	切り捨て
round	{{round a}}	四捨五入
pow	{{pow base exponent}}	べき乗
sqrt	{{sqrt a}}	平方根
random	{{random min max}}	ランダムな整数。境界値を 含みます
sum	{{sum array}}	配列の合計
avg	{{avg array}}	平均
min	{{min a b c …}}	最小値、可変長引数
max	{{max a b c …}}	最大値、可変長引数
toFixed	{{toFixed number digits}}	小数 N 桁の文字列
toInt	{{toInt number}}	整数（10 進）、失敗時は 0
toFloat	{{toFloat number}}	浮動小数点数、失敗時は 0

{"montantTTC": {{toFixed (multiply montantHT 1.2) 2}}}

配列（18）

ヘルパー	シグネチャ	効果
first	{{first array n}}	最初の要素、または先頭 n 件
last	{{last array n}}	最後の要素、または末尾 n 件
length	{{length value}}	配列や文字列の長さ、あるいはキーの数
join	{{join array separator}}	区切りは既定で ,
sort	{{sort array}}	ソートしたコピー
unique	{{unique array}}	重複を除去
after	{{after array n}}	インデックス n より後のすべて
before	{{before array n}}	インデックス n より前のすべて
slice	{{slice array start end}}	部分を取り出す
concat	{{concat a b …}}	連結し、1 段だけ平坦化
flatten	{{flatten array}}	1 段だけ平坦化
pluck	{{pluck array property}}	各要素から 1 つのプロパティを抽出
itemAt	{{itemAt array index}}	インデックス位置の要素。負のインデックスは末尾から数えます
inArray	{{#inArray array value}}…{{/inArray}}	ブロック
isArray	{{isArray value}}	真偽値
isEmpty	{{#isEmpty value}}…{{/isEmpty}}	ブロック
some	{{#some array prop value}}…{{/some}}	ブロック：少なくとも 1 つの要素が一致
every	{{#every array prop value}}…{{/every}}	ブロック：すべての要素が一致

{{join (pluck articles "reference") ","}}

オブジェクト（12）

ヘルパー	シグネチャ	効果
JSONstringify	{{JSONstringify obj}}	シリアライズ、インデント 2
JSONparse	{{JSONparse str}}	パース。失敗時は {}
get	{{get obj "a.b.c"}}	ドット区切りのパスで読み取り
isObject	{{isObject value}}	真偽値（null でも配列でもない）
typeOf	{{typeOf value}}	null、array、または JavaScript の型
keys	{{keys obj}}	キーの一覧
values	{{values obj}}	値の一覧
entries	{{entries obj}}	[key, value] の組の一覧
hasOwn	{{#hasOwn obj "key"}}…{{/hasOwn}}	ブロック
pick	{{pick obj "k1" "k2"}}	指定したキーだけを残す
omit	{{omit obj "k1"}}	指定したキーを取り除く
merge	{{merge o1 o2}}	浅いマージ

{{get reponse "data.client.identifiant"}}

URL（5）

ヘルパー	シグネチャ	効果
encodeURI	{{encodeURI s}}	URL の 1 つの構成要素 をエンコード
decodeURI	{{decodeURI s}}	デコード
urlParse	{{urlParse url}}	{ href, origin, protocol, host, hostname, port, pathname, search, hash }、または null
stripQuerystring	{{stripQuerystring url}}	クエリ文字列を取り除く
stripProtocol	{{stripProtocol url}}	スキームを取り除く

{{baseUrl}}/recherche?q={{encodeURI termeRecherche}}

日付（4）

ヘルパー	シグネチャ	効果
year	{{year}}	現在の年
now	{{now}}	現在時刻、ISO 形式
timestamp	{{timestamp}}	現在時刻、ミリ秒
formatDate	{{formatDate date "YYYY-MM-DD"}}	書式化

formatDate は意図的に最小限です

認識されるトークンは YYYY、MM、DD、HH、mm、ss だけで、 それぞれ 1 回しか置換されず、ローカル 時刻で処理されます。 既定のパターンは YYYY-MM-DD です。無効な日付は空文字列になります。

日付の加減算やより高度な書式化が必要な場合は、シナリオアクションの 日時 か コードアクション を使ってください。moment が 利用できます。

また、{{timestamp}} が ミリ秒 である一方、{{$timestamp}}（下記の Postman 互換）は 秒 であることにも注意してください。

その他（6）

ヘルパー	シグネチャ	効果
coalesce	{{coalesce a b c}}	最初の null でない値
uuid	{{uuid}}	UUID v4
noop	{{#noop}}…{{/noop}}	何もしないブロック
raw	{{{{raw}}}}…{{{{/raw}}}}	中身を解釈しません
times	{{#times n}}…{{/times}}	ブロックを繰り返す。@index、@first、@last が使えます
range	{{range start end step}}	数値の配列、終端は含みません

raw ヘルパーは、二重波かっこを あえて 送りたいときに使います。 たとえば、波かっこを自分で解釈するサービスをテストする場合です。

動的変数（Postman 互換）（22）

引数はなく、評価するたびに違う値 になります。

変数	返す値
{{$guid}}	UUID v4
{{$randomUUID}}	UUID v4
{{$timestamp}}	現在時刻、秒
{{$isoTimestamp}}	現在時刻、ISO 形式
{{$randomInt}}	0 から 1000 の整数
{{$randomAlphaNumeric}}	英数字 8 文字
{{$randomBoolean}}	true または false
{{$randomFirstName}}	名
{{$randomLastName}}	姓
{{$randomFullName}}	氏名
{{$randomUserName}}	firstname.lastname<0-99>
{{$randomEmail}}	メールアドレス
{{$randomColor}}	色名
{{$randomWord}}	単語 1 つ
{{$randomWords}}	単語 3 つ
{{$randomCompanyName}}	会社名
{{$randomCity}}	都市名
{{$randomCountry}}	国名
{{$randomPhoneNumber}}	電話番号
{{$randomIP}}	IP アドレス
{{$randomIPV4}}	IPv4 アドレス
{{$randomPrice}}	小数 2 桁の価格

{
  "correlationId": "{{$guid}}",
  "client": { "nom": "{{$randomFullName}}", "email": "{{$randomEmail}}" },
  "emisLe": "{{$isoTimestamp}}"
}

Note

値は 固定された短いリスト から取り出されます。あくまで埋め草のデータで、 現実的なデータを生成する仕組みではありません。未知の {{$random…}} 変数は 解決されないまま空文字列になり、エラーにはなりません。

再現可能 な乱数が必要な場合は、シナリオアクションの ランダム をシード付きで使ってください。

環境変数にアクセスする

変数にアクセスするためのヘルパーは ありません。変数は直接コンテキストに 入っています。{{env "baseUrl"}} ではなく {{baseUrl}} と書きます。

変数と環境 を参照してください。