alfy 2.0.0 → 2.1.0

package/index.d.ts

@@ -22,6 +22,7 @@ export type OutputOptions = {
 	readonly rerunInterval?: number;
 };
 
+// eslint-disable-next-line unicorn/prevent-abbreviations
 export type CacheConfGetOptions = {
 	/**
 	Get the item for the key provided without taking the `maxAge` of the item into account.
@@ -29,6 +30,7 @@ export type CacheConfGetOptions = {
 	readonly ignoreMaxAge?: boolean;
 };
 
+// eslint-disable-next-line unicorn/prevent-abbreviations
 export type CacheConfSetOptions = {
 	/**
 	Number of milliseconds the cached value is valid.
@@ -36,6 +38,8 @@ export type CacheConfSetOptions = {
 	readonly maxAge?: number;
 };
 
+// TODO: Rename this in the next major version.
+// eslint-disable-next-line unicorn/prevent-abbreviations
 export type CacheConf<T extends Record<string, any> = Record<string, unknown>> = {
 	isExpired: (key: keyof T) => boolean;
 

package/index.js

@@ -118,11 +118,6 @@ alfy.fetch = async (url, options) => {
 		...options,
 	};
 
-	// TODO: Remove this in 2024.
-	if (options.query) {
-		throw new Error('The `query` option was renamed to `searchParams`.');
-	}
-
 	if (typeof url !== 'string') {
 		throw new TypeError(`Expected \`url\` to be a \`string\`, got \`${typeof url}\``);
 	}

package/lib/update-notification.js

@@ -2,8 +2,8 @@ import {readPackageUp} from 'read-package-up';
 import alfredNotifier from 'alfred-notifier';
 
 export default async function updateNotification() {
-	const {package: pkg} = await readPackageUp();
-	const alfy = (pkg || {}).alfy || {};
+	const {package: package_} = await readPackageUp();
+	const alfy = package_?.alfy ?? {};
 
 	if (alfy.updateNotification !== false) {
 		alfredNotifier();

package/package.json

@@ -1,9 +1,10 @@
 {
 	"name": "alfy",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"description": "Create Alfred workflows with ease",
 	"license": "MIT",
 	"repository": "sindresorhus/alfy",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"type": "module",
 	"bin": {
 		"run-node": "./run-node.sh",
@@ -14,6 +15,7 @@
 		"types": "./index.d.ts",
 		"default": "./index.js"
 	},
+	"sideEffects": false,
 	"engines": {
 		"node": ">=18"
 	},
@@ -45,21 +47,21 @@
 		"alfred-notifier": "^0.2.3",
 		"cache-conf": "^0.6.0",
 		"clean-stack": "^5.2.0",
-		"conf": "^12.0.0",
-		"dot-prop": "^8.0.2",
-		"execa": "^8.0.1",
-		"got": "^13.0.0",
+		"conf": "^13.0.1",
+		"dot-prop": "^9.0.0",
+		"execa": "^9.3.0",
+		"got": "^14.4.2",
 		"hook-std": "^3.0.0",
 		"loud-rejection": "^2.2.0",
 		"read-package-up": "^11.0.0"
 	},
 	"devDependencies": {
-		"ava": "^5.3.1",
+		"ava": "^6.1.3",
 		"delay": "^6.0.0",
-		"nock": "^13.3.8",
+		"nock": "^13.5.4",
 		"tempfile": "^5.0.0",
-		"tsd": "^0.29.0",
-		"xo": "^0.56.0"
+		"tsd": "^0.31.1",
+		"xo": "^0.59.2"
 	},
 	"tsd": {
 		"compilerOptions": {

package/readme.md

@@ -103,7 +103,7 @@ By adding `alfy-init` as `postinstall` and `alfy-cleanup` as `preuninstall` scri
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"scripts": {
 		"postinstall": "alfy-init",
@@ -323,6 +323,29 @@ alfy.matches('Foo', list, (item, input) => item === input);
 
 Same as `matches()`, but with `alfy.input` as `input`.
 
+If you want to match against multiple items, you must define your own matching function ([as shown here](#item)). Let’s extend the [example from the beginning](#example) to search for a keyword that appears either within the `title` or `body` property or both.
+
+```js
+import alfy from 'alfy';
+
+const data = await alfy.fetch('https://jsonplaceholder.typicode.com/posts');
+
+const items = alfy
+	.inputMatches(
+		data,
+		(item, input) =>
+			item.title?.toLowerCase().includes(input) ||
+			item.body?.toLowerCase().includes(input)
+	)
+	.map((element) => ({
+		title: element.title,
+		subtitle: element.body,
+		arg: element.id,
+	}));
+
+alfy.output(items);
+```
+
 #### error(error)
 
 Display an error or error message in Alfred.