Merge pull request #3 from vxern/2-it-should-be-possible-to-override-…

…the-url-being-queried

feat: Add the ability to specify a custom definition link.

CHANGELOG.md

@@ -1,14 +1,18 @@
+# 0.0.2
+
+- Added option to override the links used by the scraper to allow specifying custom URLs (in case of proxies, etc.).
+
 # 0.0.1-patch.3
 
-- Fix package having been published without re-compilation via `tsc`.
+- Fixed package having been published without re-compilation via `tsc`.
 
 # 0.0.1-patch.2
 
-- Fix oversight involving the parser only parsing 1 part of speech per etymology.
+- Fixed oversight involving the parser only parsing 1 part of speech per etymology.
 
 # 0.0.1-patch.1
 
-- Switch from Rome to Biome, following the package having been renamed.
+- Switched from Rome to Biome, following the package having been renamed.
 
 # 0.0.1
 

package.json

@@ -2,7 +2,7 @@
 	"name": "wiktionary-scraper",
 	"description": "A lightweight scraper to fetch information about words in various languages from Wiktionary.",
 	"license": "MIT",
-	"version": "0.0.1-patch.3",
+	"version": "0.0.2",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"type": "module",

src/constants/links.ts

@@ -1,6 +1,19 @@
 import { ScraperOptions } from "../options.js";
 
-export default {
+/** Defines the links used in querying Wiktionary. */
+interface Links {
+	/**
+	 * Generates a link pointing to a word entry.
+	 *
+	 * @defaultValue `https://${options.siteLanguage}.wiktionary.org/wiki/${word}#${options.lemmaLanguage}`
+	 */
+	definition: (word: string, options: ScraperOptions) => string;
+}
+
+const links: Links = {
 	definition: (word: string, options: ScraperOptions): string =>
 		`https://${options.siteLanguage}.wiktionary.org/wiki/${word}#${options.lemmaLanguage}`,
 };
+
+export type { Links };
+export default links;

src/index.ts

@@ -10,13 +10,18 @@ const defaultScraperOptions: ScraperOptions = {
 	siteLanguage: "en",
 	userAgent: "wiktionary-scraper (github.com/vxern/wiktionary-scraper)",
 	followRedirect: false,
+	links,
 } as const;
 
 export async function get(
 	lemma: string,
 	options: Partial<ScraperOptions> = defaultScraperOptions,
 ): Promise<Entry[] | undefined> {
-	const optionsFilled: ScraperOptions = { ...defaultScraperOptions, ...options };
+	const optionsFilled: ScraperOptions = {
+		...defaultScraperOptions,
+		...options,
+		links: { ...defaultScraperOptions.links, ...options.links },
+	};
 
 	let response;
 	try {

src/options.ts

@@ -1,18 +1,20 @@
+import type { Links } from "./constants/links";
+
 export type SiteLanguage = "en";
 
 /** Defines the available options for getting a lemma from the dictionary. */
 export interface ScraperOptions {
 	/**
 	 * Specifies the language of the lemma.
 	 *
-	 * @defaultValue `"English"`
+	 * @defaultValue "English"
 	 */
 	lemmaLanguage: string;
 
 	/**
 	 * Specifies the language of the website.
 	 *
-	 * @defaultValue `"en"`
+	 * @defaultValue "en"
 	 */
 	siteLanguage: SiteLanguage;
 
@@ -21,12 +23,21 @@ export interface ScraperOptions {
 	 *
 	 * Set to {@link undefined} to omit the header.
 	 *
-	 * @defaultValue `"wiktionary-scraper (github.com/vxern/wiktionary-scraper)"`
+	 * @defaultValue "wiktionary-scraper (github.com/vxern/wiktionary-scraper)"
 	 */
 	userAgent: string | undefined;
 
 	/**
 	 * Whether the scraper should follow redirects to similar terms if the term does not exist.
+	 *
+	 * @defaultValue false
 	 */
 	followRedirect: boolean;
+
+	/**
+	 * Specifies the links to query.
+	 *
+	 * @defaultValue links
+	 */
+	links: Links;
 }

test/index.spec.ts

@@ -22,6 +22,7 @@ describe("The parser", () => {
 	});
 
 	it("returns `undefined` for redirects when following redirects is disabled.", async () => {
+		// This would redirect to "Germany" otherwise.
 		const results = await Wiktionary.get("germany");
 
 		expect(results).to.be.undefined;