From 7bb285a318d9096ded589200a4e2ee7bab325e81 Mon Sep 17 00:00:00 2001 From: Paul Paterson Date: Wed, 26 Jun 2024 11:36:50 -0400 Subject: [PATCH] fix doc strings for QueryArgument --- src/query-builder.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/query-builder.ts b/src/query-builder.ts index b1745576..381c12e9 100644 --- a/src/query-builder.ts +++ b/src/query-builder.ts @@ -8,16 +8,17 @@ import type { /** * A QueryArgumentObject is a plain javascript object where each property is a * valid QueryArgument. - * These objects can be set as values in the {@link fql} function. */ export type QueryArgumentObject = { [key: string]: QueryArgument; }; /** - * A QueryArgument is a plain javascript object where each property is a - * valid QueryArgument. - * These objects can be set as values in the {@link fql} function. + * A QueryArgument represents all possible values that can be encoded and passed + * to Fauna as a query argument. + * + * The {@link fql} tagged template function requires all arguments to be of type + * QueryArgument. */ export type QueryArgument = | QueryValue