Commit 043153f4feb56ac8a710e91fd243efb4a3ae8d03
Add muxrpc-usage help
cel committed on 8/28/2019, 10:52:14 PMParent: 5a3cd636ffd4211ee7958de59fc2011a7d6f58eb
Files changed
| index.js | changed |
| index.js | ||
|---|---|---|
| @@ -1,12 +1,56 @@ | ||
| 1 | 1 … | var ssbKeys = require('ssb-keys') |
| 2 | 2 … | var confirmer = require('./confirm') |
| 3 | 3 … | |
| 4 … | +var help = { | |
| 5 … | + description: 'Publish messages via user-confirmation', | |
| 6 … | + commands: { | |
| 7 … | + publishGetUrl: { | |
| 8 … | + description: 'Create a URL with a confirmation form for publishing a message', | |
| 9 … | + type: 'async', | |
| 10 … | + args: { | |
| 11 … | + content: { | |
| 12 … | + type: 'object', | |
| 13 … | + optional: false, | |
| 14 … | + description: 'message content to publish' | |
| 15 … | + }, | |
| 16 … | + redirectBase: { | |
| 17 … | + type: 'URL', | |
| 18 … | + optional: false, | |
| 19 … | + description: 'Base URL for post-publish redirect - with the message ID, URL-encoded, appended' | |
| 20 … | + } | |
| 21 … | + } | |
| 22 … | + }, | |
| 23 … | + privatePublishGetUrl: { | |
| 24 … | + description: 'Create a URL with a confirmation form for publishing a private message', | |
| 25 … | + type: 'async', | |
| 26 … | + args: { | |
| 27 … | + content: { | |
| 28 … | + type: 'object', | |
| 29 … | + optional: false, | |
| 30 … | + description: 'message content to publish privately' | |
| 31 … | + }, | |
| 32 … | + redirectBase: { | |
| 33 … | + type: 'URL', | |
| 34 … | + optional: false, | |
| 35 … | + description: 'base URL for post-publish redirect - with the message ID, URL-encoded, appended' | |
| 36 … | + }, | |
| 37 … | + recps: { | |
| 38 … | + type: 'FeedIds', | |
| 39 … | + optional: false, | |
| 40 … | + description: 'feed ids to encrypt message to with private-box' | |
| 41 … | + } | |
| 42 … | + } | |
| 43 … | + } | |
| 44 … | + } | |
| 45 … | +} | |
| 46 … | + | |
| 4 | 47 … | exports.name = 'publishguard' |
| 5 | 48 … | exports.version = '1.1.0' |
| 6 | 49 … | exports.manifest = { |
| 7 | 50 … | publishGetUrl: 'async', |
| 8 | 51 … | privatePublishGetUrl: 'async', |
| 52 … | + help: 'sync', | |
| 9 | 53 … | } |
| 10 | 54 … | exports.init = function (sbot, config) { |
| 11 | 55 … | var confirm |
| 12 | 56 … | setTimeout(function () { |
| @@ -43,7 +87,10 @@ | ||
| 43 | 87 … | privatePublishGetUrl: function (opts, cb) { |
| 44 | 88 … | if (!opts) throw new TypeError('missing opts') |
| 45 | 89 … | if (typeof cb !== 'function') throw new TypeError('bad callback') |
| 46 | 90 … | confirm.privatePublishGetUrl(opts, cb) |
| 91 … | + }, | |
| 92 … | + help: function () { | |
| 93 … | + return help | |
| 47 | 94 … | } |
| 48 | 95 … | } |
| 49 | 96 … | } |
Built with git-ssb-web