Skip to content

Instantly share code, notes, and snippets.

@rondinif

rondinif/PhytoJS-documentation.json

Created July 27, 2019 14:49
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rondinif/88dab50b58196348374fc2db250a7400 to your computer and use it in GitHub Desktop.
Save rondinif/88dab50b58196348374fc2db250a7400 to your computer and use it in GitHub Desktop.
Download ZIP
PhytoJS documentation
Raw
PhytoJS-documentation.json
[
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "This is a description of the Phyto constructor function.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 57,
"offset": 56
}
}
},
"tags": [
{
"title": "class",
"description": null,
"lineNumber": 2,
"type": null,
"name": null
},
{
"title": "classdesc",
"description": "This is a description of the Phyto class.",
"lineNumber": 3
}
],
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 11,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 12,
"column": 0
},
"end": {
"line": 100,
"column": 1
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [
{
"title": "param",
"name": "fetch",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a fetch function possibly polymorphic",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
},
{
"title": "param",
"name": "config",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a configuration object isomorph with @rondinif/phytojs/esm/config",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 66,
"offset": 65
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 66,
"offset": 65
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 66,
"offset": 65
}
}
},
"type": {
"type": "NameExpression",
"name": "object"
}
},
{
"title": "param",
"name": "log",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a logger object isomorph with @rondinif/phytojs/esm/log",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"type": {
"type": "NameExpression",
"name": "object"
}
},
{
"title": "param",
"name": "logconfig",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a configuration object dor the logger, isomorph with @rondinif/phytojs/esm/logconfig",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
}
}
},
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"kind": "class",
"classdesc": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "This is a description of the Phyto class.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 42,
"offset": 41
}
}
},
"constructorComment": {
"description": "",
"tags": [
{
"title": "constructor",
"description": null,
"lineNumber": 1,
"type": null,
"name": null
},
{
"title": "param",
"description": "a fetch function possibly polymorphic",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Function"
},
"name": "fetch"
},
{
"title": "param",
"description": "a configuration object isomorph with @rondinif/phytojs/esm/config",
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "object"
},
"name": "config"
},
{
"title": "param",
"description": "a logger object isomorph with @rondinif/phytojs/esm/log",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "object"
},
"name": "log"
},
{
"title": "param",
"description": "a configuration object dor the logger, isomorph with @rondinif/phytojs/esm/logconfig",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "object"
},
"name": "logconfig"
}
],
"loc": {
"start": {
"line": 13,
"column": 1
},
"end": {
"line": 19,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 20,
"column": 1
},
"end": {
"line": 34,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js",
"sortKey": "undefined 00000020",
"code": "{\n\t/**\n * @constructor\n * @param {Function} fetch - a fetch function possibly polymorphic\n * @param {object} config - a configuration object isomorph with @rondinif/phytojs/esm/config\n * @param {object} log - a logger object isomorph with @rondinif/phytojs/esm/log\n * @param {object} logconfig - a configuration object dor the logger, isomorph with @rondinif/phytojs/esm/logconfig\n */\n\tconstructor(fetch, config, log, logconfig) {\n\t\tthis._effectiveConfig = (typeof config === 'undefined') ? {isUnderTest: () => false} : config;\n\t\tthis._effectiveLog = (typeof log === 'undefined') ? new Log((typeof logconfig === 'undefined') ? {isLogVerbose: () => false, isLogSilent: () => true} : logconfig) : log;\n\n\t\tconst _ff = makeGetPromiseOfWikiDataApiResults(fetch, this._effectiveLog);\n\t\tconst _ffSparql = makeGetPromiseOfSparqlResults(fetch, this._effectiveLog);\n\n\t\tthis._wdSearchByAnyName = openDataPromisesFactories.makeWdSearchByAnyName(_ff, this._effectiveConfig, this._effectiveLog);\n\t\tthis._wdPlantsByAnyName = openDataPromisesFactories.makeWdPlantsByAnyName(_ff, this._effectiveConfig, this._effectiveLog);\n\t\tthis._resolvedPlantsByName = openDataPromisesFactories.makeResolvedPlantsByName(_ff, _ffSparql, this._effectiveConfig, this._effectiveLog);\n\t\tthis._sparqlScientificNameById = openDataPromisesFactories.makeSparqlScientificNameById(_ffSparql, this._effectiveConfig, this._effectiveLog);\n\n\t\tthis._wdEndpointUri = openDataEndpointFactories.makeWdEndpointUri(this._effectiveConfig, this._effectiveLog);\n\t\tthis._sparqlEndpointUri = openDataEndpointFactories.makeSparqlEndpointUri(this._effectiveConfig, this._effectiveLog);\n\t}\n\n\t// SECTION which concerns: `openDataPromisesFactories`\n\n\t/**\n * @param {string} name - the `name` or any `term` for which the wikidata search will be carried out\n * @return {Promise} - a Promise of the search results; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/wdSearchByAnyName)\n */\n\twdSearchByAnyName(name) {\n\t\treturn this._wdSearchByAnyName(name);\n\t}\n\n\t/**\n * @param {string} name - the `name` of the plant for which the odla search will be carried out\n * @return {Promise} - a Promise of the search results; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/wdPlantsByAnyName)\n */\n\twdPlantsByAnyName(name) {\n\t\treturn this._wdPlantsByAnyName(name);\n\t}\n\n\t/**\n * @param {string} name - the `name` of the plant for which the odla re-solver will go to find valid entities uniquely identifiable by means of an `id` and a `scientific-name`\n * @return {Promise} - a Promise of results with the list resolved plants; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/resolvedPlantsByName)\n */\n\tresolvedPlantsByName(name) {\n\t\treturn this._resolvedPlantsByName(name);\n\t}\n\n\t/**\n * @param {string} id - the `id` of the entitity for which the odla re-solver will go to find valid `scientific-name`\n * @return {Promise} - a Promise of results with the list of `scientific-name` of the resolved plants; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/sparqlScientificNameById)\n */\n\tsparqlScientificNameById(id) {\n\t\treturn this._sparqlScientificNameById(id);\n\t}\n\n\t// SECTION which concerns: `openDataEndpointFactories`\n\n\t/**\n * @return {string} - the `SPARQL endpoint` which will be used by the `OpenDataLogicAgent`\n */\n\tgetSparqlEndpointUri() {\n\t\treturn this._sparqlEndpointUri();\n\t}\n\n\t/**\n * @return {string} - the `Wikidata API endpoint` which will be used by the `OpenDataLogicAgent`\n */\n\tgetWikiDataApiEndpointUri() {\n\t\treturn this._wdEndpointUri();\n\t}\n\n\t/**\n * @return {object} - the effective `configuration` which will be used by the `OpenDataLogicAgent`\n */\n\tconfig() {\n\t\treturn this._effectiveConfig;\n\t}\n\n\t/**\n * @return {object} - the effective `logger` which will be used by the `OpenDataLogicAgent`\n */\n\tlogger() {\n\t\t// #DEBUG console.log(`####:${this._effectiveLog}`);\n\t\treturn this._effectiveLog;\n\t}\n}"
},
"augments": [],
"errors": [],
"examples": [],
"implements": [],
"params": [
{
"title": "param",
"name": "fetch",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a fetch function possibly polymorphic",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 38,
"offset": 37
}
}
},
"type": {
"type": "NameExpression",
"name": "Function"
}
},
{
"title": "param",
"name": "config",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a configuration object isomorph with @rondinif/phytojs/esm/config",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 66,
"offset": 65
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 66,
"offset": 65
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 66,
"offset": 65
}
}
},
"type": {
"type": "NameExpression",
"name": "object"
}
},
{
"title": "param",
"name": "log",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a logger object isomorph with @rondinif/phytojs/esm/log",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"type": {
"type": "NameExpression",
"name": "object"
}
},
{
"title": "param",
"name": "logconfig",
"lineNumber": 5,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a configuration object dor the logger, isomorph with @rondinif/phytojs/esm/logconfig",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 85,
"offset": 84
}
}
},
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"properties": [],
"returns": [],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"kind": "class"
},
"name": "Phyto",
"members": {
"global": [],
"inner": [],
"instance": [
{
"description": "",
"tags": [
{
"title": "param",
"description": "the `name` or any `term` for which the wikidata search will be carried out",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "string"
},
"name": "name"
},
{
"title": "return",
"description": "a Promise of the search results; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/wdSearchByAnyName)",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"loc": {
"start": {
"line": 38,
"column": 1
},
"end": {
"line": 41,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 42,
"column": 1
},
"end": {
"line": 44,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [
{
"title": "param",
"name": "name",
"lineNumber": 1,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "name",
"position": {
"start": {
"line": 1,
"column": 5,
"offset": 4
},
"end": {
"line": 1,
"column": 11,
"offset": 10
},
"indent": []
}
},
{
"type": "text",
"value": " or any ",
"position": {
"start": {
"line": 1,
"column": 11,
"offset": 10
},
"end": {
"line": 1,
"column": 19,
"offset": 18
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "term",
"position": {
"start": {
"line": 1,
"column": 19,
"offset": 18
},
"end": {
"line": 1,
"column": 25,
"offset": 24
},
"indent": []
}
},
{
"type": "text",
"value": " for which the wikidata search will be carried out",
"position": {
"start": {
"line": 1,
"column": 25,
"offset": 24
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 75,
"offset": 74
}
}
},
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a Promise of the search results; @see ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/blob/master/test/lib/",
"children": [
{
"type": "text",
"value": "tests",
"position": {
"start": {
"line": 1,
"column": 40,
"offset": 39
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 39,
"offset": 38
},
"end": {
"line": 1,
"column": 105,
"offset": 104
},
"indent": []
}
},
{
"type": "text",
"value": " and ",
"position": {
"start": {
"line": 1,
"column": 105,
"offset": 104
},
"end": {
"line": 1,
"column": 110,
"offset": 109
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/wdSearchByAnyName",
"children": [
{
"type": "text",
"value": "expectations",
"position": {
"start": {
"line": 1,
"column": 111,
"offset": 110
},
"end": {
"line": 1,
"column": 123,
"offset": 122
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 110,
"offset": 109
},
"end": {
"line": 1,
"column": 227,
"offset": 226
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 227,
"offset": 226
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 227,
"offset": 226
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "wdSearchByAnyName",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "wdSearchByAnyName",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#wdSearchByAnyName"
},
{
"description": "",
"tags": [
{
"title": "param",
"description": "the `name` of the plant for which the odla search will be carried out",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "string"
},
"name": "name"
},
{
"title": "return",
"description": "a Promise of the search results; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/wdPlantsByAnyName)",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"loc": {
"start": {
"line": 46,
"column": 1
},
"end": {
"line": 49,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 50,
"column": 1
},
"end": {
"line": 52,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [
{
"title": "param",
"name": "name",
"lineNumber": 1,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "name",
"position": {
"start": {
"line": 1,
"column": 5,
"offset": 4
},
"end": {
"line": 1,
"column": 11,
"offset": 10
},
"indent": []
}
},
{
"type": "text",
"value": " of the plant for which the odla search will be carried out",
"position": {
"start": {
"line": 1,
"column": 11,
"offset": 10
},
"end": {
"line": 1,
"column": 70,
"offset": 69
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
}
}
},
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a Promise of the search results; @see ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/blob/master/test/lib/",
"children": [
{
"type": "text",
"value": "tests",
"position": {
"start": {
"line": 1,
"column": 40,
"offset": 39
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 39,
"offset": 38
},
"end": {
"line": 1,
"column": 105,
"offset": 104
},
"indent": []
}
},
{
"type": "text",
"value": " and ",
"position": {
"start": {
"line": 1,
"column": 105,
"offset": 104
},
"end": {
"line": 1,
"column": 110,
"offset": 109
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/wdPlantsByAnyName",
"children": [
{
"type": "text",
"value": "expectations",
"position": {
"start": {
"line": 1,
"column": 111,
"offset": 110
},
"end": {
"line": 1,
"column": 123,
"offset": 122
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 110,
"offset": 109
},
"end": {
"line": 1,
"column": 227,
"offset": 226
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 227,
"offset": 226
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 227,
"offset": 226
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "wdPlantsByAnyName",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "wdPlantsByAnyName",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#wdPlantsByAnyName"
},
{
"description": "",
"tags": [
{
"title": "param",
"description": "the `name` of the plant for which the odla re-solver will go to find valid entities uniquely identifiable by means of an `id` and a `scientific-name`",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "string"
},
"name": "name"
},
{
"title": "return",
"description": "a Promise of results with the list resolved plants; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/resolvedPlantsByName)",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"loc": {
"start": {
"line": 54,
"column": 1
},
"end": {
"line": 57,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 58,
"column": 1
},
"end": {
"line": 60,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [
{
"title": "param",
"name": "name",
"lineNumber": 1,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "name",
"position": {
"start": {
"line": 1,
"column": 5,
"offset": 4
},
"end": {
"line": 1,
"column": 11,
"offset": 10
},
"indent": []
}
},
{
"type": "text",
"value": " of the plant for which the odla re-solver will go to find valid entities uniquely identifiable by means of an ",
"position": {
"start": {
"line": 1,
"column": 11,
"offset": 10
},
"end": {
"line": 1,
"column": 122,
"offset": 121
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "id",
"position": {
"start": {
"line": 1,
"column": 122,
"offset": 121
},
"end": {
"line": 1,
"column": 126,
"offset": 125
},
"indent": []
}
},
{
"type": "text",
"value": " and a ",
"position": {
"start": {
"line": 1,
"column": 126,
"offset": 125
},
"end": {
"line": 1,
"column": 133,
"offset": 132
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "scientific-name",
"position": {
"start": {
"line": 1,
"column": 133,
"offset": 132
},
"end": {
"line": 1,
"column": 150,
"offset": 149
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 150,
"offset": 149
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 150,
"offset": 149
}
}
},
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a Promise of results with the list resolved plants; @see ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 58,
"offset": 57
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/blob/master/test/lib/",
"children": [
{
"type": "text",
"value": "tests",
"position": {
"start": {
"line": 1,
"column": 59,
"offset": 58
},
"end": {
"line": 1,
"column": 64,
"offset": 63
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 58,
"offset": 57
},
"end": {
"line": 1,
"column": 124,
"offset": 123
},
"indent": []
}
},
{
"type": "text",
"value": " and ",
"position": {
"start": {
"line": 1,
"column": 124,
"offset": 123
},
"end": {
"line": 1,
"column": 129,
"offset": 128
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/resolvedPlantsByName",
"children": [
{
"type": "text",
"value": "expectations",
"position": {
"start": {
"line": 1,
"column": 130,
"offset": 129
},
"end": {
"line": 1,
"column": 142,
"offset": 141
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 129,
"offset": 128
},
"end": {
"line": 1,
"column": 249,
"offset": 248
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 249,
"offset": 248
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 249,
"offset": 248
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "resolvedPlantsByName",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "resolvedPlantsByName",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#resolvedPlantsByName"
},
{
"description": "",
"tags": [
{
"title": "param",
"description": "the `id` of the entitity for which the odla re-solver will go to find valid `scientific-name`",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "string"
},
"name": "id"
},
{
"title": "return",
"description": "a Promise of results with the list of `scientific-name` of the resolved plants; @see [tests](https://github.com/rondinif/phytojs/blob/master/test/lib/) and [expectations](https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/sparqlScientificNameById)",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"loc": {
"start": {
"line": 62,
"column": 1
},
"end": {
"line": 65,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 66,
"column": 1
},
"end": {
"line": 68,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [
{
"title": "param",
"name": "id",
"lineNumber": 1,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "id",
"position": {
"start": {
"line": 1,
"column": 5,
"offset": 4
},
"end": {
"line": 1,
"column": 9,
"offset": 8
},
"indent": []
}
},
{
"type": "text",
"value": " of the entitity for which the odla re-solver will go to find valid ",
"position": {
"start": {
"line": 1,
"column": 9,
"offset": 8
},
"end": {
"line": 1,
"column": 77,
"offset": 76
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "scientific-name",
"position": {
"start": {
"line": 1,
"column": 77,
"offset": 76
},
"end": {
"line": 1,
"column": 94,
"offset": 93
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 94,
"offset": 93
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 94,
"offset": 93
}
}
},
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "a Promise of results with the list of ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 39,
"offset": 38
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "scientific-name",
"position": {
"start": {
"line": 1,
"column": 39,
"offset": 38
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
},
{
"type": "text",
"value": " of the resolved plants; @see ",
"position": {
"start": {
"line": 1,
"column": 56,
"offset": 55
},
"end": {
"line": 1,
"column": 86,
"offset": 85
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/blob/master/test/lib/",
"children": [
{
"type": "text",
"value": "tests",
"position": {
"start": {
"line": 1,
"column": 87,
"offset": 86
},
"end": {
"line": 1,
"column": 92,
"offset": 91
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 86,
"offset": 85
},
"end": {
"line": 1,
"column": 152,
"offset": 151
},
"indent": []
}
},
{
"type": "text",
"value": " and ",
"position": {
"start": {
"line": 1,
"column": 152,
"offset": 151
},
"end": {
"line": 1,
"column": 157,
"offset": 156
},
"indent": []
}
},
{
"type": "link",
"title": null,
"url": "https://github.com/rondinif/phytojs/tree/master/test/fixture/lib/OpenDataLogicAgent/sparqlScientificNameById",
"children": [
{
"type": "text",
"value": "expectations",
"position": {
"start": {
"line": 1,
"column": 158,
"offset": 157
},
"end": {
"line": 1,
"column": 170,
"offset": 169
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 157,
"offset": 156
},
"end": {
"line": 1,
"column": 281,
"offset": 280
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 281,
"offset": 280
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 281,
"offset": 280
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "sparqlScientificNameById",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "sparqlScientificNameById",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#sparqlScientificNameById"
},
{
"description": "",
"tags": [
{
"title": "return",
"description": "the `SPARQL endpoint` which will be used by the `OpenDataLogicAgent`",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"loc": {
"start": {
"line": 72,
"column": 1
},
"end": {
"line": 74,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 75,
"column": 1
},
"end": {
"line": 77,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "SPARQL endpoint",
"position": {
"start": {
"line": 1,
"column": 5,
"offset": 4
},
"end": {
"line": 1,
"column": 22,
"offset": 21
},
"indent": []
}
},
{
"type": "text",
"value": " which will be used by the ",
"position": {
"start": {
"line": 1,
"column": 22,
"offset": 21
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "OpenDataLogicAgent",
"position": {
"start": {
"line": 1,
"column": 49,
"offset": 48
},
"end": {
"line": 1,
"column": 69,
"offset": 68
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "getSparqlEndpointUri",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "getSparqlEndpointUri",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#getSparqlEndpointUri"
},
{
"description": "",
"tags": [
{
"title": "return",
"description": "the `Wikidata API endpoint` which will be used by the `OpenDataLogicAgent`",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"loc": {
"start": {
"line": 79,
"column": 1
},
"end": {
"line": 81,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 82,
"column": 1
},
"end": {
"line": 84,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 5,
"offset": 4
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "Wikidata API endpoint",
"position": {
"start": {
"line": 1,
"column": 5,
"offset": 4
},
"end": {
"line": 1,
"column": 28,
"offset": 27
},
"indent": []
}
},
{
"type": "text",
"value": " which will be used by the ",
"position": {
"start": {
"line": 1,
"column": 28,
"offset": 27
},
"end": {
"line": 1,
"column": 55,
"offset": 54
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "OpenDataLogicAgent",
"position": {
"start": {
"line": 1,
"column": 55,
"offset": 54
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 75,
"offset": 74
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "getWikiDataApiEndpointUri",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "getWikiDataApiEndpointUri",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#getWikiDataApiEndpointUri"
},
{
"description": "",
"tags": [
{
"title": "return",
"description": "the effective `configuration` which will be used by the `OpenDataLogicAgent`",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 86,
"column": 1
},
"end": {
"line": 88,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 89,
"column": 1
},
"end": {
"line": 91,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the effective ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 15,
"offset": 14
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "configuration",
"position": {
"start": {
"line": 1,
"column": 15,
"offset": 14
},
"end": {
"line": 1,
"column": 30,
"offset": 29
},
"indent": []
}
},
{
"type": "text",
"value": " which will be used by the ",
"position": {
"start": {
"line": 1,
"column": 30,
"offset": 29
},
"end": {
"line": 1,
"column": 57,
"offset": 56
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "OpenDataLogicAgent",
"position": {
"start": {
"line": 1,
"column": 57,
"offset": 56
},
"end": {
"line": 1,
"column": 77,
"offset": 76
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 77,
"offset": 76
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 77,
"offset": 76
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "config",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "config",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#config"
},
{
"description": "",
"tags": [
{
"title": "return",
"description": "the effective `logger` which will be used by the `OpenDataLogicAgent`",
"lineNumber": 1,
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"loc": {
"start": {
"line": 93,
"column": 1
},
"end": {
"line": 95,
"column": 6
}
},
"context": {
"loc": {
"start": {
"line": 96,
"column": 1
},
"end": {
"line": 99,
"column": 2
}
},
"file": "/Users/ronda/projects/rondinif/phytojs/src/main.js"
},
"augments": [],
"examples": [],
"implements": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the effective ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 15,
"offset": 14
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "logger",
"position": {
"start": {
"line": 1,
"column": 15,
"offset": 14
},
"end": {
"line": 1,
"column": 23,
"offset": 22
},
"indent": []
}
},
{
"type": "text",
"value": " which will be used by the ",
"position": {
"start": {
"line": 1,
"column": 23,
"offset": 22
},
"end": {
"line": 1,
"column": 50,
"offset": 49
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "OpenDataLogicAgent",
"position": {
"start": {
"line": 1,
"column": 50,
"offset": 49
},
"end": {
"line": 1,
"column": 70,
"offset": 69
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 70,
"offset": 69
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "object"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"yields": [],
"name": "logger",
"kind": "function",
"memberof": "Phyto",
"scope": "instance",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
},
{
"name": "logger",
"kind": "function",
"scope": "instance"
}
],
"namespace": "Phyto#logger"
}
],
"events": [],
"static": []
},
"path": [
{
"name": "Phyto",
"kind": "class"
}
],
"namespace": "Phyto"
}
]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment