fix: Rename precondition. (#246)

Author: goloroden

README.md

@@ -94,17 +94,17 @@ const writtenEvents = await client.writeEvents([
 
 *Note that according to the CloudEvents standard, event IDs must be of type string.*
 
-#### Using the `isEventQlTrue` precondition
+#### Using the `isEventQlQueryTrue` precondition
 
-If you want to write events depending on an EventQL query, import the `isEventQlTrue` function and pass it as an array of preconditions in the second argument:
+If you want to write events depending on an EventQL query, import the `isEventQlQueryTrue` function and pass it as an array of preconditions in the second argument:
 
 ```typescript
-import { isEventQlTrue } from 'eventsourcingdb';
+import { isEventQlQueryTrue } from 'eventsourcingdb';
 
 const writtenEvents = await client.writeEvents([
   // events
 ], [
-  isEventQlTrue(`FROM e IN events WHERE e.type == 'io.eventsourcingdb.library.book-borrowed' PROJECT INTO COUNT() < 10`)
+  isEventQlQueryTrue(`FROM e IN events WHERE e.type == 'io.eventsourcingdb.library.book-borrowed' PROJECT INTO COUNT() < 10`)
 ]);
 ```
 

src/Precondition.ts

@@ -7,7 +7,7 @@ interface IsSubjectOnEventIdPrecondition {
 	eventId: string;
 }
 
-interface IsEventQlTruePrecondition {
+interface IsEventQlQueryTruePrecondition {
 	query: string;
 }
 
@@ -21,8 +21,8 @@ type Precondition =
 			payload: IsSubjectOnEventIdPrecondition;
 	  }
 	| {
-			type: 'isEventQlTrue';
-			payload: IsEventQlTruePrecondition;
+			type: 'isEventQlQueryTrue';
+			payload: IsEventQlQueryTruePrecondition;
 	  };
 
 export type { Precondition };

src/isEventQlQueryTrue.ts

@@ -0,0 +1,10 @@
+import type { Precondition } from './Precondition.js';
+
+const isEventQlQueryTrue = (query: string): Precondition => {
+	return {
+		type: 'isEventQlQueryTrue',
+		payload: { query },
+	};
+};
+
+export { isEventQlQueryTrue };

src/isEventQlTrue.ts

@@ -3,7 +3,7 @@ import { afterEach, beforeEach, suite, test } from 'node:test';
 import { Container } from './Container.js';
 import type { EventCandidate } from './EventCandidate.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
-import { isEventQlTrue } from './isEventQlTrue.js';
+import { isEventQlQueryTrue } from './isEventQlQueryTrue.js';
 import { isSubjectOnEventId } from './isSubjectOnEventId.js';
 import { isSubjectPristine } from './isSubjectPristine.js';
 
@@ -145,7 +145,7 @@ suite('writeEvents', { timeout: 30_000 }, () => {
 		);
 	});
 
-	test('supports the isEventQlTrue precondition.', async (): Promise<void> => {
+	test('supports the isEventQlQueryTrue precondition.', async (): Promise<void> => {
 		const client = container.getClient();
 
 		const firstEvent: EventCandidate = {
@@ -172,7 +172,7 @@ suite('writeEvents', { timeout: 30_000 }, () => {
 			async () => {
 				await client.writeEvents(
 					[secondEvent],
-					[isEventQlTrue('FROM e IN events PROJECT INTO COUNT() == 0')],
+					[isEventQlQueryTrue('FROM e IN events PROJECT INTO COUNT() == 0')],
 				);
 			},
 			error => {