MCPcopy
hub / github.com/jsdoc/jsdoc / isTutorialJSON

Function isTutorialJSON

lib/jsdoc/tutorial/resolver.js:22–25  ·  view source on GitHub ↗

checks if `conf` is the metadata for a single tutorial. * A tutorial's metadata has a property 'title' and/or a property 'children'. * @param {object} json - the object we want to test (typically from JSON.parse) * @returns {boolean} whether `json` could be the metadata for a tutorial.

(json)

Source from the content-addressed store, hash-verified

20 * @returns {boolean} whether `json` could be the metadata for a tutorial.
21 */
22function isTutorialJSON(json) {
23 // if conf.title exists or conf.children exists, it is metadata for a tutorial
24 return (hasOwnProp.call(json, 'title') || hasOwnProp.call(json, 'children'));
25}
26
27/**
28 * Root tutorial.

Callers 1

addTutorialConfFunction · 0.85

Calls

no outgoing calls

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…