fixed typos

CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.19.0
 
-- Added `pb.filter(rawExpr, params?)` helper to constructs a filter string with binded placeholder parameters.
+- Added `pb.filter(rawExpr, params?)` helper to construct a filter string with placeholder parameters populated from an object.
 
     ```js
     const record = await pb.collection("example").getList(1, 20, {

README.md

@@ -113,20 +113,20 @@ The SDK comes with a helper `pb.filter(expr, params)` method to generate a filte
 **This method is also recommended when using the SDK in Node/Deno/Bun server-side list queries and accepting untrusted user input as `filter` string arguments, because it will take care to properly escape the generated string expression, avoiding eventual string injection attacks** (_on the client-side this is not much of an issue_).
 
 ```js
-const record = await pb.collection("example").getList(1, 20, {
+const records = await pb.collection("example").getList(1, 20, {
   // the same as: "title ~ 'te\\'st' && (totalA = 123 || totalB = 123)"
   filter: pb.filter("title ~ {:title} && (totalA = {:num} || totalB = {:num})", { title: "te'st", num: 123 })
 })
 ```
 
 The supported placeholder parameter values are:
 
-- `string` (_single quotes will be autoescaped_)
+- `string` (_single quotes are autoescaped_)
 - `number`
 - `boolean`
 - `Date` object (_will be stringified into the format expected by PocketBase_)
 - `null`
-- anything else is converted to a string using `JSON.stringify()`
+- everything else is converted to a string using `JSON.stringify()`
 
 
 ### File upload

dist/pocketbase.cjs.d.ts

@@ -1072,16 +1072,18 @@ declare class Client {
      */
     cancelAllRequests(): Client;
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * The following parameter values are supported:
+     *
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *
@@ -1093,16 +1095,18 @@ declare class Client {
      * ```
      */
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
+     *
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * The following parameter values are supported:
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *

dist/pocketbase.es.d.mts

@@ -1078,16 +1078,18 @@ declare class Client {
      */
     cancelAllRequests(): Client;
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * The following parameter values are supported:
+     *
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *

dist/pocketbase.es.d.ts

@@ -1078,16 +1078,18 @@ declare class Client {
      */
     cancelAllRequests(): Client;
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * The following parameter values are supported:
+     *
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *

dist/pocketbase.iife.d.ts

@@ -1072,16 +1072,18 @@ declare class Client {
      */
     cancelAllRequests(): Client;
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * The following parameter values are supported:
+     *
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *
@@ -1093,16 +1095,18 @@ declare class Client {
      * ```
      */
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
+     *
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * The following parameter values are supported:
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *

dist/pocketbase.umd.d.ts

@@ -1072,16 +1072,18 @@ declare class Client {
      */
     cancelAllRequests(): Client;
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * The following parameter values are supported:
+     *
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *
@@ -1093,16 +1095,18 @@ declare class Client {
      * ```
      */
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
+     *
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * The following parameter values are supported:
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *

src/Client.ts

@@ -221,16 +221,18 @@ export default class Client {
     }
 
     /**
-     * Constructs a properly escaped filter expression.
+     * Constructs a filter expression with placeholders populated from a parameters object.
      *
-     * Placeholder parameters should be added using the `{:paramName}` notation.
+     * Placeholder parameters are defined with the `{:paramName}` notation.
      *
-     * - `string` (_single quotes will be autoescaped_)
+     * The following parameter values are supported:
+     *
+     * - `string` (_single quotes are autoescaped_)
      * - `number`
      * - `boolean`
-     * - `Date` object (_will be stringified into the format expected by PocketBase_)
+     * - `Date` object (_stringified into the PocketBase datetime format_)
      * - `null`
-     * - anything else is converted to a string using `JSON.stringify()`
+     * - everything else is converted to a string using `JSON.stringify()`
      *
      * Example:
      *