openethereum/js/packages/jsonrpc/helpers.js

93 lines
2.4 KiB
JavaScript
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
// A dummy placeholder object that will stringify literally to anything
// in the example source.
//
// { {
// foo: new Dummy('{ ... }') -------> "foo": { ... }
// } {
//
export class Dummy {
constructor (value) {
this.value = value;
}
toString () {
return this.value;
}
toJSON () {
return `##${this.value}##`;
}
static fixJSON (json) {
return json.replace(/"##([^#]+)##"/g, '$1');
}
static isDummy (obj) {
return obj instanceof Dummy;
}
static stringifyJSON (any) {
return Dummy.fixJSON(JSON.stringify(any));
}
}
// Enrich the API spec by additional markdown-formatted preamble
export function withPreamble (preamble, spec) {
Object.defineProperty(spec, '_preamble', {
value: preamble.trim(),
enumerable: false
});
return spec;
}
// Enrich any example value with a comment to print in the docs
export function withComment (example, comment) {
const constructor = example == null ? null : example.constructor;
if (constructor === Object || constructor === Array) {
Object.defineProperty(example, '_comment', {
value: comment,
enumerable: false
});
return example;
}
// Convert primitives
return new PrimitiveWithComment(example, comment);
}
// Turn a decimal number into a hexadecimal string with comment to it's original value
export function fromDecimal (decimal) {
return withComment(`0x${decimal.toString(16)}`, decimal.toString());
}
// Internal helper
class PrimitiveWithComment {
constructor (primitive, comment) {
this._value = primitive;
this._comment = comment;
}
toJSON () {
return this._value;
}
}