update README; add a few more types

README.md

@@ -6,7 +6,7 @@
 
 Development status: Unstable. Versioning: while mwn is in version 0, changes may be made to the public interface with a change in the minor version number.
 
-Documentation given below is incomplete. There are a number of additional classes such as `bot.title`, `bot.wikitext`, `bot.page`, etc that provide useful functionality but aren't documented. 
+Documentation given below is incomplete. There are a number of additional classes such as `bot.title`, `bot.wikitext`, `bot.page`, etc that provide useful functionality but aren't documented. You can learn about these by looking through the source code. 
 
 Amongst the major highlights are `batchOperation` and `seriesBatchOperation` which allow you run a large number of tasks with control over concurrency and sleep time between tasks. Failing actions can be automatically retried. 
 
@@ -52,6 +52,19 @@ If you're migrating from mwbot, note that:
 
 ### Documentation
 
+Importing mwn:
+
+In JavaScript:
+```js
+const {mwn} = require('mwn');
+```
+Note: Prior to mwn v0.8.0, import was via `const mwn = require('mwn');`
+
+In TypeScript: 
+```ts
+import {mwn} from 'mwn';
+```
+
 Create a new bot instance:
 ```js
 const bot = new mwn({
@@ -208,11 +221,6 @@ Parse the contents of a given page
 bot.parseTitle('Page name', additionalOptions);
 ```
 
-Rollback a user:
-```js
-bot.rollback('Page title', 'user', additionalOptions);
-```
-
 Upload a file from your system to the wiki:
 ```js
 bot.upload('File title', '/path/to/file', 'comment', customParams);

build/api_params.d.ts

@@ -1,4 +1,4 @@
-import { MwnDate } from "./bot";
+import type { MwnDate } from "./bot";
 declare type timestamp = MwnDate | string;
 declare type namespace = number;
 declare type limit = number | 'max';

build/bot.d.ts

@@ -553,7 +553,7 @@ export declare class mwn {
      * @returns {Promise<ApiPage>}
      */
     read(titles: string | string[] | number | number[], options?: ApiParams): Promise<ApiPage | ApiPage[]>;
-    readGen(titles: string[], options?: ApiParams): AsyncGenerator<any, void, unknown>;
+    readGen(titles: string[], options?: ApiParams): AsyncGenerator<ApiPage>;
     /**
     * @param {string|number|MwnTitle} title - Page title or page ID or MwnTitle object
     * @param {Function} transform - Callback that prepares the edit. It takes one
@@ -750,9 +750,7 @@ export declare class mwn {
      * @param {number} [limit=Infinity]
      * @yields {Object} a single page of the response
      */
-    continuedQueryGen(query?: ApiParams, limit?: number): AsyncGenerator<{
-        continue: {};
-    }, void, unknown>;
+    continuedQueryGen(query?: ApiParams, limit?: number): AsyncGenerator<ApiResponse>;
     /**
      * Function for using API action=query with more than 50/500 items in multi-
      * input fields.
@@ -786,7 +784,7 @@ export declare class mwn {
      * @param {string} [batchFieldName=titles]
      * @param {number} [batchSize]
      */
-    massQueryGen(query: ApiParams, batchFieldName?: string, batchSize?: number): AsyncGenerator<any, void, unknown>;
+    massQueryGen(query: ApiParams, batchFieldName?: string, batchSize?: number): AsyncGenerator<ApiResponse>;
     /**
      * Execute an asynchronous function on a large number of pages (or other arbitrary
      * items). Designed for working with promises.

package.json

@@ -6,7 +6,6 @@
 	"scripts": {
 		"bump": "node bump-version.js",
 		"build": "npx tsc",
-		"commit": "npm run build && git commit",
 		"test": "nyc --reporter=lcov --reporter=text mocha tests/",
 		"coverage": "nyc report --reporter=text-lcov | coveralls",
 		"test-ts": "ts-mocha -p tsconfig.json tests/ts/*"

src/api_params.ts

@@ -1,4 +1,4 @@
-import {MwnDate} from "./bot";
+import type {MwnDate} from "./bot";
 
 type timestamp = MwnDate | string
 type namespace = number

src/bot.ts

@@ -1245,7 +1245,7 @@ export class mwn {
 		});
 	}
 
-	async *readGen(titles: string[], options?: ApiParams) {
+	async *readGen(titles: string[], options?: ApiParams): AsyncGenerator<ApiPage> {
 		let massQueryResponses = this.massQueryGen({
 			action: 'query',
 			...makeTitles(titles),
@@ -1750,7 +1750,7 @@ export class mwn {
 	 * @param {number} [limit=Infinity]
 	 * @yields {Object} a single page of the response
 	 */
-	async *continuedQueryGen(query?: ApiParams, limit = Infinity) {
+	async *continuedQueryGen(query?: ApiParams, limit = Infinity): AsyncGenerator<ApiResponse>  {
 		let response = { continue: {} };
 		for (let i = 0; i < limit; i++) {
 			if (response.continue) {
@@ -1826,7 +1826,7 @@ export class mwn {
 	 * @param {string} [batchFieldName=titles]
 	 * @param {number} [batchSize]
 	 */
-	async *massQueryGen(query: ApiParams, batchFieldName: string = 'titles', batchSize?: number) {
+	async *massQueryGen(query: ApiParams, batchFieldName: string = 'titles', batchSize?: number): AsyncGenerator<ApiResponse> {
 		let batchValues = query[batchFieldName];
 		if (!Array.isArray(batchValues)) {
 			throw new Error(`massQuery: batch field in query must be an array`);