zcy
/
svgedit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Docs(imagelib): Further jsdoc work

master
Brett Zamir 2020-01-04 17:05:11 +08:00
parent d7d6b87255
commit e0ceec2a38
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
editor/extensions/ext-imagelib.js
View File

@ -76,27 +76,32 @@ export default {
let preview, submit; let preview, submit;
/** /**
* @typedef {PlainObject} ImageLibMessage * Contains the SVG to insert.
* @property {"imagelib"} namespace Required to distinguish from any other messages of app. * @typedef {PlainObject} ImageLibMessage
* @property {string} href Set to same value as previous `ImageLibMetaMessage` `id`. * @property {"imagelib"} namespace Required to distinguish from any other messages of app.
* @property {string} data The response (as an SVG string or URL) * @property {string} href Set to same value as previous `ImageLibMetaMessage` `id`.
* @property {string} data The response (as an SVG string or URL)
*/ */
/** /**
* Used for setting meta-data before images are retrieved.
* @typedef {PlainObject} ImageLibMetaMessage * @typedef {PlainObject} ImageLibMetaMessage
* @property {"imagelib"} namespace Required to distinguish from any other messages of app. * @property {"imagelib"} namespace Required to distinguish from any other messages of app.
* @property {string} name If the subsequent response is an SVG string or if `preview_url` * @property {string} name If the subsequent response is an SVG string or if `preview_url`
* is present, will be used as the title for the preview image. When an * is present, will be used as the title for the preview image. When an
* SVG string is present, will default to the first `<title>`'s contents or * SVG string is present, will default to the first `<title>`'s contents or
* "(SVG #<Length of response>)" if none is present. Otherwise, if `preview_url` * "(SVG #<Length of response>)" if none is present. Otherwise, if `preview_url`
* is present, will default to the empty string. * is present, will default to the empty string. Though `name` may be falsy,
* it is always expected to be present for meta messages.
* @property {string} id Identifier (the expected `href` for a subsequent response message); * @property {string} id Identifier (the expected `href` for a subsequent response message);
* used for ensuring the subsequent response can be tied to this `ImageLibMetaMessage` object. * used for ensuring the subsequent response can be tied to this `ImageLibMetaMessage` object.
* @property {string} [preview_url] Used to set an image source along with the * @property {string} [preview_url] When import mode is multiple, used to set an image
* name/title. If the subsequent response is an SVG string and there is no `preview_url`, * source along with the name/title. If the subsequent response is an SVG string
* the default will just be to show the name/title. If the response is not an SVG * and there is no `preview_url`, the default will just be to show the
* string, the default will be to show that response (i.e., the URL). * name/title. If the response is not an SVG string, the default will be to
* @property {string} entry Set automatically with div holding retrieving message (until ready to delete) * show that response (i.e., the URL).
* @property {string} entry Set automatically with div holding retrieving
* message (until ready to delete)
* @todo Should use a separate Map instead of `entry` * @todo Should use a separate Map instead of `entry`
*/ */