diff options
author | Soreine <nicolas@gitbook.com> | 2016-05-10 12:19:59 +0200 |
---|---|---|
committer | Soreine <nicolas@gitbook.com> | 2016-05-11 13:11:32 +0200 |
commit | e137bf632a5ae39c82f4513eed6c15eeb87b110a (patch) | |
tree | 9aeb5761f2087a846ce2a8aa30755c65be45df01 /lib/modifiers | |
parent | 2fef898a1e13dc6b3f2627ed83af2865f51d2ffa (diff) | |
download | gitbook-e137bf632a5ae39c82f4513eed6c15eeb87b110a.zip gitbook-e137bf632a5ae39c82f4513eed6c15eeb87b110a.tar.gz gitbook-e137bf632a5ae39c82f4513eed6c15eeb87b110a.tar.bz2 |
Adds editArticleRef
Diffstat (limited to 'lib/modifiers')
-rw-r--r-- | lib/modifiers/summary/editArticleRef.js | 17 | ||||
-rw-r--r-- | lib/modifiers/summary/index.js | 1 | ||||
-rw-r--r-- | lib/modifiers/summary/moveArticleAfter.js | 4 |
3 files changed, 21 insertions, 1 deletions
diff --git a/lib/modifiers/summary/editArticleRef.js b/lib/modifiers/summary/editArticleRef.js new file mode 100644 index 0000000..7106960 --- /dev/null +++ b/lib/modifiers/summary/editArticleRef.js @@ -0,0 +1,17 @@ +var mergeAtLevel = require('./mergeAtLevel'); + +/** + Edit the ref of an article + + @param {Summary} summary + @param {String} level + @param {String} newRef + @return {Summary} +*/ +function editArticleRef(summary, level, newRef) { + return mergeAtLevel(summary, level, { + ref: newRef + }); +} + +module.exports = editArticleRef; diff --git a/lib/modifiers/summary/index.js b/lib/modifiers/summary/index.js index 3ee0367..f91fdb6 100644 --- a/lib/modifiers/summary/index.js +++ b/lib/modifiers/summary/index.js @@ -5,6 +5,7 @@ module.exports = { removeArticle: require('./removeArticle'), unshiftArticle: require('./unshiftArticle'), editArticleTitle: require('./editArticleTitle'), + editArticleRef: require('./editArticleRef'), insertPart: require('./insertPart'), removePart: require('./removePart'), diff --git a/lib/modifiers/summary/moveArticleAfter.js b/lib/modifiers/summary/moveArticleAfter.js index e03eae9..e268f73 100644 --- a/lib/modifiers/summary/moveArticleAfter.js +++ b/lib/modifiers/summary/moveArticleAfter.js @@ -3,7 +3,9 @@ var removeArticle = require('./removeArticle'); var insertArticle = require('./insertArticle'); /** - Returns a new summary, with the an article moved after another article. + Returns a new summary, with the an article moved after another + article. Unlike `moveArticle`, does not ensure that the article + will be found at the target's level plus one. @param {Summary} summary @param {String|SummaryArticle} origin |