enmi-conf.org: comparison wp/wp-includes/js/dist/shortcode.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-includes/js/dist/shortcode.js

changeset 22	8c2e4d02f4ef
parent 21	48c4eec2b7e6

equal deleted inserted replaced

-:48c4eec2b7e6
+:8c2e4d02f4ef
 "default": () => (/* binding */ build_module)
 });
 // UNUSED EXPORTS: attrs, fromMatch, next, regexp, replace, string
-;// CONCATENATED MODULE: ./node_modules/memize/dist/index.js
+;// ./node_modules/memize/dist/index.js
 /**
 * Memize options object.
 *
 * @typedef MemizeOptions
 *
 	return memoized;
 }
-;// CONCATENATED MODULE: ./node_modules/@wordpress/shortcode/build-module/index.js
+;// ./node_modules/@wordpress/shortcode/build-module/index.js
 /**
 * External dependencies
 */
-/**
-* Shortcode attributes object.
-*
-* @typedef {Object} WPShortcodeAttrs
-*
-* @property {Object} named   Object with named attributes.
-* @property {Array}  numeric Array with numeric attributes.
-*/
-/**
-* Shortcode object.
-*
-* @typedef {Object} WPShortcode
-*
-* @property {string}           tag     Shortcode tag.
-* @property {WPShortcodeAttrs} attrs   Shortcode attributes.
-* @property {string}           content Shortcode content.
-* @property {string}           type    Shortcode type: `self-closing`,
-*                                      `closed`, or `single`.
-*/
-/**
-* @typedef {Object} WPShortcodeMatch
-*
-* @property {number}      index     Index the shortcode is found at.
-* @property {string}      content   Matched content.
-* @property {WPShortcode} shortcode Shortcode instance of the match.
-*/
 /**
 * Find the next matching shortcode.
 *
 * @param {string} tag   Shortcode tag.
 * @param {string} text  Text to search.
 * @param {number} index Index to start search from.
 *
-* @return {WPShortcodeMatch | undefined} Matched information.
+* @return {import('./types').ShortcodeMatch | undefined} Matched information.
 */
 function next(tag, text, index = 0) {
 const re = regexp(tag);
 re.lastIndex = index;
 const match = re.exec(text);
 }
 /**
 * Replace matching shortcodes in a block of text.
 *
-* @param {string}   tag      Shortcode tag.
+* @param {string}                            tag      Shortcode tag.
-* @param {string}   text     Text to search.
+* @param {string}                            text     Text to search.
-* @param {Function} callback Function to process the match and return
+* @param {import('./types').ReplaceCallback} callback Function to process the match and return
-*                            replacement string.
+*                                                     replacement string.
 *
 * @return {string} Text with shortcodes replaced.
 */
 function replace(tag, text, callback) {
 return text.replace(regexp(tag), function (match, left, $3, attrs, slash, content, closing, right) {
 * or `name=value`. Numeric attributes can be formatted as `"value"` or just
 * `value`.
 *
 * @param {string} text Serialised shortcode attributes.
 *
-* @return {WPShortcodeAttrs} Parsed shortcode attributes.
+* @return {import('./types').ShortcodeAttrs} Parsed shortcode attributes.
 */
 const attrs = memize(text => {
 const named = {};
 const numeric = [];
 *
 * Accepts a `match` object from calling `regexp.exec()` on a `RegExp` generated
 * by `regexp()`. `match` can also be set to the `arguments` from a callback
 * passed to `regexp.replace()`.
 *
-* @param {Array} match Match array.
+* @param {import('./types').Match} match Match array.
 *
-* @return {WPShortcode} Shortcode instance.
+* @return {InstanceType<import('./types').shortcode>} Shortcode instance.
 */
 function fromMatch(match) {
 let type;
 if (match[4]) {
 type = 'self-closing';
 * To access a raw representation of a shortcode, pass an `options` object,
 * containing a `tag` string, a string or object of `attrs`, a string indicating
 * the `type` of the shortcode ('single', 'self-closing', or 'closed'), and a
 * `content` string.
 *
-* @param {Object} options Options as described.
+* @type {import('./types').shortcode} Shortcode instance.
-*
-* @return {WPShortcode} Shortcode instance.
 */
 const shortcode = Object.assign(function (options) {
 const {
 tag,
 attrs: attributes,
 * accordingly.
 *
 * @param {(number|string)} attr  Attribute key.
 * @param {string}          value Attribute value.
 *
-* @return {WPShortcode} Shortcode instance.
+* @return {InstanceType< import('./types').shortcode >} Shortcode instance.
 */
 set(attr, value) {
 this.attrs[typeof attr === 'number' ? 'numeric' : 'named'][attr] = value;
 return this;
 },

enmi-conf.org