Merge pull request #160 from dijs/chaining

Chaining
dijs · Aug 12, 2021 · a91e4ec · a91e4ec
2 parents 66c7bf4 + 0f286f2
commit a91e4ec
Show file tree

Hide file tree

Showing 52 changed files with 25,877 additions and 41 deletions.
diff --git a/.jsdoc.json b/.jsdoc.json
@@ -1,39 +1,36 @@
 {
-    "tags": {
-        "allowUnknownTags": true,
-        "dictionaries": ["jsdoc"]
-    },
-    "source": {
-        "include": [
-          "src/coordinates.js",
-          "src/page.js",
-          "src/util.js",
-          "src/wiki.js",
-          "package.json",
-          "README.md"
-        ],
-        "includePattern": ".js$",
-        "excludePattern": "(node_modules/|docs)"
-    },
-    "plugins": [
-        "plugins/markdown"
-    ],
-    "templates": {
-        "cleverLinks": false,
-        "monospaceLinks": true,
-        "default": {
-          "staticFiles": {
-            "include": [
-                "./static"
-            ]
-          }
-        }
-    },
-    "opts": {
-        "destination": "./docs",
-        "encoding": "utf8",
-        "private": true,
-        "recurse": true,
-        "template": "./node_modules/minami"
-    }
+	"tags": {
+		"allowUnknownTags": true,
+		"dictionaries": ["jsdoc"]
+	},
+	"source": {
+		"include": [
+			"src/coordinates.js",
+			"src/page.js",
+			"src/util.js",
+			"src/chain.js",
+			"src/wiki.js",
+			"package.json",
+			"README.md"
+		],
+		"includePattern": ".js$",
+		"excludePattern": "(node_modules/|docs)"
+	},
+	"plugins": ["plugins/markdown"],
+	"templates": {
+		"cleverLinks": false,
+		"monospaceLinks": true,
+		"default": {
+			"staticFiles": {
+				"include": ["./static"]
+			}
+		}
+	},
+	"opts": {
+		"destination": "./docs",
+		"encoding": "utf8",
+		"private": true,
+		"recurse": true,
+		"template": "./node_modules/minami"
+	}
 }
diff --git a/README.md b/README.md
@@ -98,6 +98,35 @@ wiki({
 }).search('Winterfell');
 ```
 
+## Chain data requests together for more efficient applications
+
+Query a specific page:
+
+```js
+wiki()
+	.page('albert einstein')
+	.then(page =>
+		page
+			.chain()
+			.summary()
+			.image()
+			.links()
+			.request()
+	);
+```
+
+Or query many pages at once:
+
+```js
+wiki()
+	.chain()
+	.geosearch(52.52437, 13.41053)
+	.summary()
+	.image()
+	.coordinates()
+	.request();
+```
+
 ## Parsing Wiki Infobox Data
 
 The code Wikipedia uses for infobox data is strange and complex. So I have split the parsing code into another library. You can find it [here](https://github.com/dijs/infobox-parser).