63 lines
1.9 KiB
JavaScript
63 lines
1.9 KiB
JavaScript
|
// Copyright 2015, 2016 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/>.
|
||
|
|
|
||
|
|
// Placeholders for objects with undefined fields, will show up in docs as `{ ... }`
|
||
|
|
export const DUMMY = '$DUMMY$';
|
||
|
|
|
||
|
|
// 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;
|
||
|
|
}
|
||
|
|
}
|