mirror of https://github.com/node-red/node-red.git
100 lines
4.7 KiB
HTML
100 lines
4.7 KiB
HTML
|
|
<script type="text/x-red" data-template-name="json">
|
|
<div class="form-row">
|
|
<label for="node-input-action"><i class="fa fa-dot-circle-o"></i> <span data-i18n="json.label.action"></span></label>
|
|
<select style="width:70%" id="node-input-action">
|
|
<option value="" data-i18n="json.label.actions.toggle"></option>
|
|
<option value="str" data-i18n="json.label.actions.str"></option>
|
|
<option value="obj" data-i18n="json.label.actions.obj"></option>
|
|
</select>
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-property"><i class="fa fa-ellipsis-h"></i> <span data-i18n="json.label.property"></span></label>
|
|
<input type="text" id="node-input-property" style="width:70%;"/>
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
|
|
</div>
|
|
<hr align="middle"/>
|
|
<div class="form-row node-json-to-json-options">
|
|
<label style="width:100%; border-bottom: 1px solid #eee;"><span data-i18n="json.label.o2j"></span></label>
|
|
</div>
|
|
<div class="form-row node-json-to-json-options" style="padding-left: 20px;">
|
|
<input style="width:20px; vertical-align:top; margin-right: 5px;" type="checkbox" id="node-input-pretty"><label style="width: auto;" for="node-input-pretty" data-i18n="json.label.pretty"></span>
|
|
</div>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="json">
|
|
<p>Converts between a JSON string and its JavaScript object representation, in either direction.</p>
|
|
<h3>Inputs</h3>
|
|
<dl class="message-properties">
|
|
<dt>payload<span class="property-type">object | string</span></dt>
|
|
<dd>A JavaScript object or JSON string.</dd>
|
|
<dt>schema<span class="property-type">object</span></dt>
|
|
<dd>An optional JSON Schema object to validate the payload against.</dd>
|
|
</dl>
|
|
<h3>Outputs</h3>
|
|
<dl class="message-properties">
|
|
<dt>payload<span class="property-type">object | string</span></dt>
|
|
<dd>
|
|
<ul>
|
|
<li>If the input is a JSON string it tries to parse it to a JavaScript object.</li>
|
|
<li>If the input is a JavaScript object it creates a JSON string. The string can optionally be well-formatted.</li>
|
|
</ul>
|
|
</dd>
|
|
<dt>schemaError<span class="property-type">array</span></dt>
|
|
<dd>If JSON schema validation fails, the catch node will have a <code>schemaError</code> property
|
|
containing an array of errors.</dd>
|
|
</dl>
|
|
<h3>Details</h3>
|
|
<p>By default, the node operates on <code>msg.payload</code>, but can be configured
|
|
to convert any message property.</p>
|
|
<p>The node can also be configured to ensure a particular encoding instead of toggling
|
|
between the two. This can be used, for example, with the <code>HTTP In</code>
|
|
node to ensure the payload is a parsed object even if an incoming request
|
|
did not set its content-type correctly for the HTTP In node to do the conversion.</p>
|
|
<p>If the node is configured to ensure the property is encoded as a String and it
|
|
receives a String, no further checks will be made of the property. It will
|
|
not check the String is valid JSON nor will it reformat it if the format option
|
|
is selected.</p>
|
|
<p>For more details about JSON Schema you can consult the specification
|
|
<a href="http://json-schema.org/latest/json-schema-validation.html">here</a>.</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType('json',{
|
|
category: 'function',
|
|
color:"#DEBD5C",
|
|
defaults: {
|
|
name: {value:""},
|
|
property: {value:"payload",required:true},
|
|
action: {value:""},
|
|
pretty: {value:false}
|
|
},
|
|
inputs:1,
|
|
outputs:1,
|
|
icon: "parser-json.png",
|
|
label: function() {
|
|
return this.name||"json";
|
|
},
|
|
labelStyle: function() {
|
|
return this.name?"node_label_italic":"";
|
|
},
|
|
oneditprepare: function() {
|
|
if (this.property === undefined) {
|
|
$("#node-input-property").val("payload");
|
|
}
|
|
$("#node-input-property").typedInput({default:'msg',types:['msg']});
|
|
$("#node-input-action").change(function() {
|
|
if (this.value === "" || this.value === "str") {
|
|
$(".node-json-to-json-options").show();
|
|
} else {
|
|
$(".node-json-to-json-options").hide();
|
|
}
|
|
});
|
|
$("#node-input-action").change();
|
|
}
|
|
});
|
|
</script>
|