2017-06-26 10:41:16 +02:00
{
"$string" : {
2019-10-28 14:45:53 +01:00
"args" : "arg[, prettify]" ,
"desc" : "以下の型変換ルールを用いて、引数 *arg* を文字列へ型変換します。:\n\n - 文字列は変換しません。\n - 関数は空の文字列に変換します。\n - JSONの数値として表現できないため、無限大やNaNはエラーになります。\n - 他の値は `JSON.stringify` 関数を用いて、JSONの文字列へ変換します。`prettify`が真の場合、JSONを整形出力します。フィールドを1行毎に出力。フィールドのネスト深さによってインデントを行います。"
2017-06-26 10:41:16 +02:00
} ,
"$length" : {
"args" : "str" ,
2017-06-28 10:26:07 +02:00
"desc" : "文字列 `str` の文字数を返します。 `str` が文字列でない場合、エラーを返します。"
2017-06-26 10:41:16 +02:00
} ,
"$substring" : {
"args" : "str, start[, length]" ,
"desc" : "位置 `start` (ゼロオフセット)から開始する引数 `str` の文字列を返します。 `length` を指定した場合、部分文字列は最大 `length` 文字を持ちます。 `start` が負の値の場合、その値は `str` の末尾からの文字数を指します。"
} ,
"$substringBefore" : {
"args" : "str, chars" ,
"desc" : "`str` 内で先頭に存在する文字列 `chars` より前の部分文字列を返します。 `str` が `chars` を持たない場合、 `str` を返します。"
} ,
"$substringAfter" : {
"args" : "str, chars" ,
"desc" : "`str` 内で先頭に存在する文字列 `chars` より後ろの部分文字列を返します。 `str` が `chars` を持たない場合、 `str` を返します。"
} ,
"$uppercase" : {
"args" : "str" ,
"desc" : "`str` の全ての文字を大文字にした文字列を返します。"
} ,
"$lowercase" : {
"args" : "str" ,
"desc" : "`str` の全ての文字を小文字にした文字列を返します。"
} ,
"$trim" : {
"args" : "str" ,
2017-06-28 10:26:07 +02:00
"desc" : "以下のステップを適用して `str` 内の全ての空白文字を取り除き、正規化します。\n\n - 全てのタブ、キャリッジリターン、ラインフィードを空白に置き換える。\n- 連続する空白を1つの空白に減らす。\n- 末尾と先頭の空白を削除する。\n\n `str` を指定しない場合(例: 本関数を引数なしで呼び出す)、コンテキスト値を `str` の値として使用します。 `str` が文字列でない場合、エラーになります。"
2017-06-26 10:41:16 +02:00
} ,
"$contains" : {
"args" : "str, pattern" ,
"desc" : "`str` が `pattern` とマッチした場合は `true` 、マッチしない場合は `false` を返します。 `str` を指定しない場合(例: 本関数を1つの引数で呼び出す)、コンテキスト値を `str` の値として使用します。引数 `pattern` は文字列や正規表現とすることができます。"
} ,
"$split" : {
"args" : "str[, separator][, limit]" ,
"desc" : "引数 `str` を分割し、部分文字列の配列にします。 `str` が文字列でない場合、エラーになります。省略可能な引数 `separator` には `str` を分割する文字を文字列または正規表現で指定します。 `separator` を指定しない場合、空の文字列と見なし、 `str` は1文字ずつから成る配列に分割します。 `separator` が文字列でない場合、エラーになります。省略可能な引数 `limit` には、結果の配列が持つ部分文字列の最大数を指定します。この数を超える部分文字列は破棄されます。 `limit` を指定しない場合、 `str` は結果の配列のサイズに上限なく完全に分割されます。 `limit` が負の値の場合、エラーになります。"
} ,
"$join" : {
"args" : "array[, separator]" ,
2017-06-28 10:26:07 +02:00
"desc" : "文字列の配列を、省略可能な引数 `separator` で区切った1つの文字列へ連結します。配列 `array` が文字列でない要素を含む場合、エラーになります。 `separator` を指定しない場合、空の文字列と見なします(例: 文字列間の `separator` なし)。 `separator` が文字列でない場合、エラーになります。"
2017-06-26 10:41:16 +02:00
} ,
"$match" : {
"args" : "str, pattern [, limit]" ,
"desc" : "文字列 `str` に対して正規表現 `pattern` を適用し、オブジェクトの配列を返します。配列要素のオブジェクトは `str` のうちマッチした部分の情報を保持します。"
} ,
"$replace" : {
"args" : "str, pattern, replacement [, limit]" ,
2017-06-28 10:26:07 +02:00
"desc" : "文字列 `str` からパターン `pattern` を検索し、置換文字列 `replacement` に置き換えます。\n\n任意の引数 `limit` には、置換回数の上限値を指定します。"
} ,
"$now" : {
2021-06-29 09:42:16 +02:00
"args" : "$[picture [, timezone]]" ,
2021-06-13 07:19:36 +02:00
"desc" : "ISO 8601互換形式の時刻を生成し、文字列として返します。pictureおよびtimezoneパラメータが指定されている場合、現在時刻を`$fromMillis()`関数の説明に従ってフォーマットします。"
2017-06-28 10:26:07 +02:00
} ,
"$base64encode" : {
"args" : "string" ,
"desc" : "ASCII形式の文字列をBase 64形式へ変換します。文字列内の各文字は、バイナリデータのバイト値として扱われます。文字列内の文字は、URIエンコードした文字列も含め、0x00から0xFFの範囲である必要があります。範囲外のユニコードの文字はサポートされません。"
} ,
"$base64decode" : {
"args" : "string" ,
"desc" : "UTF-8のコードページを用いて、Base 64形式のバイト値を文字列に変換します。"
2017-06-26 10:41:16 +02:00
} ,
"$number" : {
"args" : "arg" ,
2017-06-28 10:26:07 +02:00
"desc" : "以下の型変換ルールを用いて、引数 `arg` を数値へ変換します。:\n\n - 数値は、変換しません。\n - 正しいJSONの数値を表す文字列は、数値に変換します。\n - 他の形式の値は、エラーになります。"
} ,
"$abs" : {
"args" : "number" ,
"desc" : "引数 `number` の絶対値を返します。"
} ,
"$floor" : {
"args" : "number" ,
"desc" : "`number` の値を `number` 以下の最も近い整数値へ切り捨てた値を返します。"
} ,
"$ceil" : {
"args" : "number" ,
"desc" : "`number` の値を `number` 以上の最も近い整数値へ切り上げた値を返します。"
} ,
"$round" : {
"args" : "number [, precision]" ,
"desc" : "引数 `number` の値を四捨五入した値を返します。任意の引数 `precision` には、四捨五入で用いる小数点以下の桁数を指定します。"
} ,
"$power" : {
"args" : "base, exponent" ,
"desc" : "基数 `base` を指数 `exponent` 分、累乗した値を返します。"
} ,
"$sqrt" : {
"args" : "number" ,
"desc" : "引数 `number` の平方根を返します。"
} ,
"$random" : {
"args" : "" ,
"desc" : "0以上、1未満の疑似乱数を返します。"
2017-06-26 10:41:16 +02:00
} ,
2017-10-10 21:21:19 +02:00
"$millis" : {
"args" : "" ,
"desc" : "Unixエポック(1 January, 1970 UTC)からの経過ミリ秒を数値として返します。評価対象式に含まれる `$millis()` の呼び出しは、全て同じ値を返します。"
} ,
2017-06-26 10:41:16 +02:00
"$sum" : {
"args" : "array" ,
2017-06-28 10:26:07 +02:00
"desc" : "数値の配列 `array` の合計値を返します。 `array` が数値でない要素を含む場合、エラーになります。"
2017-06-26 10:41:16 +02:00
} ,
"$max" : {
"args" : "array" ,
2017-06-28 10:26:07 +02:00
"desc" : "数値の配列 `array` 内の最大値を返します。 `array` が数値でない要素を含む場合、エラーになります。"
2017-06-26 10:41:16 +02:00
} ,
"$min" : {
"args" : "array" ,
2017-06-28 10:26:07 +02:00
"desc" : "数値の配列 `array` 内の最小値を返します。 `array` が数値でない要素を含む場合、エラーになります。"
2017-06-26 10:41:16 +02:00
} ,
"$average" : {
"args" : "array" ,
2017-06-28 10:26:07 +02:00
"desc" : "数値の配列 `array` の平均値を返します。 `array` が数値でない要素を含む場合、エラーになります。"
2017-06-26 10:41:16 +02:00
} ,
"$boolean" : {
"args" : "arg" ,
"desc" : "以下のルールを用いて、ブーリアン型へ型変換します。:\n\n - `Boolean` : 変換しない\n - `string`: 空 : `false`\n - `string`: 空でない : `true`\n - `number`: `0` : `false`\n - `number`: 0でない : `true`\n - `null` : `false`\n - `array`: 空 : `false`\n - `array`: `true` に型変換された要素を持つ: `true`\n - `array`: 全ての要素が `false` に型変換: `false`\n - `object`: 空 : `false`\n - `object`: 空でない : `true`\n - `function` : `false`"
} ,
"$not" : {
"args" : "arg" ,
2017-06-28 10:26:07 +02:00
"desc" : "引数の否定をブーリアン型で返します。 `arg` は最初にブーリアン型に型変換されます。"
2017-06-26 10:41:16 +02:00
} ,
"$exists" : {
"args" : "arg" ,
"desc" : "`arg` の式の評価値が存在する場合は `true` 、式の評価結果が未定義の場合(例: 存在しない参照フィールドへのパス)は `false` を返します。"
} ,
"$count" : {
"args" : "array" ,
"desc" : "配列の要素数を返します。"
} ,
"$append" : {
"args" : "array, array" ,
"desc" : "2つの配列を連結します。"
} ,
2017-06-28 10:26:07 +02:00
"$sort" : {
"args" : "array [, function]" ,
"desc" : "配列 `array` 内の値を並び変えた配列を返します。\n\n比較関数 `function` を用いる場合、比較関数は以下のとおり2つの引数を持つ必要があります。\n\n`function(left, right)`\n\n比較関数は、leftとrightの2つの値を比較するために、値を並び替える処理で呼び出されます。もし、求められる並び順にてleftの値をrightの値より後ろに置きたい場合は、比較関数は置き換えを表すブーリアン型の `true` を返す必要があります。一方、置き換えが不要の場合は `false` を返す必要があります。"
} ,
"$reverse" : {
"args" : "array" ,
"desc" : "配列 `array` の値を、逆順にした配列を返します。"
} ,
"$shuffle" : {
"args" : "array" ,
"desc" : "配列 `array` の値を、ランダムな順番にした配列を返します。"
} ,
"$zip" : {
"args" : "array, ..." ,
"desc" : "配列 `array1` … `arrayN` の位置 0, 1, 2.... の値を要素とする配列から成る配列を返します。"
} ,
2017-06-26 10:41:16 +02:00
"$keys" : {
"args" : "object" ,
2017-06-28 10:26:07 +02:00
"desc" : "オブジェクト内のキーを含む配列を返します。引数がオブジェクトの配列の場合、返す配列は全オブジェクトの全キーの重複の無いリストとなります。"
2017-06-26 10:41:16 +02:00
} ,
"$lookup" : {
"args" : "object, key" ,
"desc" : "オブジェクト内のキーが持つ値を返します。最初の引数がオブジェクトの配列の場合、配列内の全てのオブジェクトを検索し、存在する全てのキーが持つ値を返します。"
} ,
"$spread" : {
"args" : "object" ,
"desc" : "key/valueのペアを持つオブジェクトを、各要素が1つのkey/valueのペアを持つオブジェクトの配列に分割します。引数がオブジェクトの配列の場合、結果の配列は各オブジェクトから得た各key/valueのペアのオブジェクトを持ちます。"
} ,
2017-10-10 21:21:19 +02:00
"$merge" : {
"args" : "array<object>" ,
"desc" : "`object` の配列を1つの `object` へマージします。 マージ結果のオブジェクトは入力配列内の各オブジェクトのkey/valueペアを含みます。入力のオブジェクトが同じキーを持つ場合、戻り値の `object` には配列の最後のオブジェクトのkey/value値が格納されます。入力の配列がオブジェクトでない要素を含む場合、エラーとなります。"
} ,
2017-06-28 10:26:07 +02:00
"$sift" : {
"args" : "object, function" ,
"desc" : "引数 `object` が持つkey/valueのペアのうち、関数 `function` によってふるい分けたオブジェクトのみを返します。\n\n関数 `function` は、以下の引数を持つ必要があります。\n\n`function(value [, key [, object]])`"
} ,
"$each" : {
"args" : "object, function" ,
"desc" : "`object` の各key/valueのペアに対して、関数 `function` を適用し、その返却値から成る配列を返します。"
} ,
"$map" : {
"args" : "array, function" ,
"desc" : "配列 `array` 内の各値に対して、関数 `function` を適用した結果から成る配列を返します。\n\n関数 `function` は、以下の引数を持つ必要があります。\n\n`function(value [, index [, array]])`"
} ,
"$filter" : {
"args" : "array, function" ,
"desc" : "配列 `array` 内の値のうち、関数 `function` の条件を満たす値のみを持つ配列を返します。\n\n関数 `function` は、以下の引数を持つ必要があります。\n\n`function(value [, index [, array]])`"
} ,
"$reduce" : {
"args" : "array, function [, init]" ,
2019-10-28 14:45:53 +01:00
"desc" : "配列の各要素値に関数 `function` を連続的に適用して得られる集約値を返します。 `function` の適用の際には、直前の `function` の適用結果と要素値が引数として与えられます。\n\n関数 `function` は引数を2つ取り、配列の各要素の間に配置する中置演算子のように作用しなくてはなりません。関数`function`のシグネチャは`myfunc($accumulator, $value[, $index[, $array]])`という形式でなければなりません。\n\n任意の引数 `init` には、集約時の初期値を設定します。"
2017-06-28 10:26:07 +02:00
} ,
2017-06-26 10:41:16 +02:00
"$flowContext" : {
"args" : "string" ,
"desc" : "フローコンテキストのプロパティを取得します。"
} ,
"$globalContext" : {
"args" : "string" ,
"desc" : "グローバルコンテキストのプロパティを取得します。"
2018-01-31 11:45:31 +01:00
} ,
"$pad" : {
"args" : "string, width [, char]" ,
"desc" : "文字数が引数 `width` の絶対値以上となるよう、必要に応じて追加文字を付け足した `string` のコピーを返します。\n\n`width` が正の値の場合、文字列の右側に追加文字を付け足します。もし負の値の場合、文字列の左側に追加文字を付け足します。\n\n任意の引数 `char` には、本関数で用いる追加文字を指定します。もし追加文字を指定しない場合は、既定値として空白文字を使用します。"
} ,
"$fromMillis" : {
2021-06-13 07:19:36 +02:00
"args" : "number, [, picture [, timezone]]" ,
"desc" : "Unixエポック(1 January, 1970 UTC)からの経過ミリ秒を表す数値を、`picture`の指定に従ってタイムスタンプの文字列に変換します。\n\n`picture`パラメータが指定されない場合、ISO 8601形式に変換します。\n\n`picture`を指定すると、指定した文字列に従って変換を行います。この変換はXPath F&O 3.1仕様におけるXPath/XQueryの2引数形式`format-dateTime`と同様です。`picture`パラメータはタイムスタンプの変換形式を定義し、その書式は`format-dateTime`と同じです。\n\n`timezone`を指定すると、指定タイムゾーンで変換します。`timezone`は'±HHMM'という形式で指定します。ここで、±は+もしくは-記号を表し、HHMMはUTCからの差分時間と分を表します。正の差分はUTCの東、負の差分は西のタイムゾーンとなります。"
2018-01-31 11:45:31 +01:00
} ,
"$formatNumber" : {
"args" : "number, picture [, options]" ,
"desc" : "`number` を文字列へ変換し、文字列 `picture` に指定した数値表現になるよう書式を変更します。\n\nこの関数の動作は、XPath F&O 3.1の仕様に定義されているXPath/XQuery関数のfn:format-numberの動作と同じです。引数の文字列 picture は、fn:format-numberと同じ構文で数値の書式を定義します。\n\n任意の第三引数 `options` は、小数点記号の様な既定のロケール固有の書式設定文字を上書きするために使用します。この引数を指定する場合、XPath F&O 3.1の仕様の数値形式の項に記述されているname/valueペアを含むオブジェクトでなければなりません。"
} ,
"$formatBase" : {
"args" : "number [, radix]" ,
"desc" : "`number` を引数 `radix` に指定した値を基数とした形式の文字列に変換します。 `radix` が指定されていない場合、基数10を既定値として設定します。 `radix` には2～
} ,
"$toMillis" : {
"args" : "timestamp" ,
"desc" : "ISO 8601形式の文字列 `timestamp` を、Unixエポック(1 January, 1970 UTC)からの経過ミリ秒を表す数値へ変換します。 文字列が正しい形式でない場合、エラーとなります。"
2018-07-13 08:17:30 +02:00
} ,
"$env" : {
"args" : "arg" ,
"desc" : "環境変数の値を返します。\n\n本関数はNode-REDの定義関数です。"
2019-02-07 04:49:36 +01:00
} ,
"$eval" : {
"args" : "expr [, context]" ,
2019-02-19 06:24:37 +01:00
"desc" : "JSONリテラルもしくはJSONata式を表す`expr`を評価します。評価の際には現在のコンテキストをコンテキストとして用います。"
2019-02-07 04:49:36 +01:00
} ,
"$formatInteger" : {
"args" : "number, picture" ,
"desc" : "`number`を`picture`指定に従って文字列に変換します。`picture`文字列は数値の変換方法をXPath F&O 3.1仕様の`fn:format-integer`に従って定義します。"
} ,
"$parseInteger" : {
"args" : "string, picture" ,
"desc" : "`picture`文字列の指定に従って、`string`パラメータを整数(JSON数値)に変換します。`picture`文字列は`$formatInteger`と同じ形式です。"
2019-10-28 14:45:53 +01:00
} ,
"$error" : {
"args" : "[str]" ,
"desc" : "メッセージを指定して例外を送出します。メッセージ`str`を省略した場合は`$error() function evaluated`をメッセージとします。"
} ,
"$assert" : {
"args" : "arg, str" ,
"desc" : "`arg`が真の場合、undefinedを返します。偽の場合、`str`をメッセージとする例外を送出します。"
} ,
"$single" : {
"args" : "array, function" ,
"desc" : "`array`の要素のうち、条件判定関数`function`を満たす(`function`に与えた場合に真偽値`true`を返す)要素が1つのみである場合、それを返します。マッチする要素が1つのみでない場合、例外を送出します。\n\n指定する関数は`function(value [, index [, array]])`というシグネチャでなければなりません。ここで、`value`は`array`の要素値、`index`は要素の添字、第三引数には配列全体を渡します。"
} ,
2021-01-27 21:33:54 +01:00
"$encodeUrlComponent" : {
2019-10-28 14:45:53 +01:00
"args" : "str" ,
2020-02-06 08:14:09 +01:00
"desc" : "Uniform Resource Locator (URL)を構成する文字を1、2、3、もしくは、4文字エスケープシーケンスのUTF-8文字エンコーディングで置換します。\n\n例: `$encodeUrlComponent(\"?x=test\")` => `\"%3Fx%3Dtest\"`"
2019-10-28 14:45:53 +01:00
} ,
2021-01-27 21:33:54 +01:00
"$encodeUrl" : {
2019-10-28 14:45:53 +01:00
"args" : "str" ,
2020-02-06 08:14:09 +01:00
"desc" : "Uniform Resource Locator (URL)要素を構成する文字を1、2、3、もしくは、4文字エスケープシーケンスのUTF-8文字エンコーディングで置換します。\n\n例: `$encodeUrl(\"https://mozilla.org/?x=шеллы\")` => `\"https://mozilla.org/?x=%D1%88%D0%B5%D0%BB%D0%BB%D1%8B\"`"
2019-10-28 14:45:53 +01:00
} ,
2021-01-27 21:33:54 +01:00
"$decodeUrlComponent" : {
2019-10-28 14:45:53 +01:00
"args" : "str" ,
"desc" : "encodeUrlComponentで置換したUniform Resource Locator (URL)をデコードします。\n\n例: `$decodeUrlComponent(\"%3Fx%3Dtest\")` => `\"?x=test\"`"
} ,
2021-01-27 21:33:54 +01:00
"$decodeUrl" : {
2019-10-28 14:45:53 +01:00
"args" : "str" ,
"desc" : "encodeUrlで置換したUniform Resource Locator (URL)要素をデコードします。 \n\n例: `$decodeUrl(\"https://mozilla.org/?x=%D1%88%D0%B5%D0%BB%D0%BB%D1%8B\")` => `\"https://mozilla.org/?x=шеллы\"`"
} ,
"$distinct" : {
"args" : "array" ,
"desc" : "配列`array`から重複要素を削除した配列を返します。"
2020-02-06 08:14:09 +01:00
} ,
"$type" : {
"args" : "value" ,
"desc" : "`value` の型を文字列として返します。もし `value` が未定義の場合、 `undefined` が返されます。"
2020-06-16 14:32:10 +02:00
} ,
"$moment" : {
"args" : "[str]" ,
"desc" : "Momentライブラリを使用して日付オブジェクトを取得します。"
2017-06-26 10:41:16 +02:00
}
}
