Skip to content

Commit 7c664e5

Browse files
committed
style: remove trailing whitespace from JSDoc comments
Clean up JSDoc comment formatting by removing trailing spaces after asterisks in multi-line documentation blocks across pg/index.ts, pg/operators.ts, and schema/src/index.ts.
1 parent f89f02f commit 7c664e5

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

packages/drizzle/src/pg/index.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ const columnConfigMap = new Map<
3636

3737
/**
3838
* Creates an encrypted column type for Drizzle ORM with configurable searchable encryption options.
39-
*
39+
*
4040
* When data is encrypted, the actual stored value is an [EQL v2](/docs/reference/eql) encrypted composite type which includes any searchable encryption indexes defined for the column.
4141
* Importantly, the original data type is not known until it is decrypted. Therefore, this function allows specifying
4242
* the original data type via the `dataType` option in the configuration.
@@ -46,23 +46,23 @@ const columnConfigMap = new Map<
4646
* @param name - The column name in the database
4747
* @param config - Optional configuration for data type and searchable encryption indexes
4848
* @returns A Drizzle column type that can be used in pgTable definitions
49-
*
49+
*
5050
* ## Searchable Encryption Options
51-
*
51+
*
5252
* - `dataType`: Specifies the original data type of the column (e.g., 'string', 'number', 'json'). Default is 'string'.
5353
* - `freeTextSearch`: Enables free text search index. Can be a boolean for default options, or an object for custom configuration.
5454
* - `equality`: Enables equality index. Can be a boolean for default options, or an array of token filters.
5555
* - `orderAndRange`: Enables order and range index for sorting and range queries.
56-
*
56+
*
5757
* See {@link EncryptedColumnConfig}.
5858
*
5959
* @example
6060
* Defining a drizzle table schema for postgres table with encrypted columns.
61-
*
61+
*
6262
* ```typescript
6363
* import { pgTable, integer, timestamp } from 'drizzle-orm/pg-core'
6464
* import { encryptedType } from '@cipherstash/drizzle/pg'
65-
*
65+
*
6666
* const users = pgTable('users', {
6767
* email: encryptedType('email', {
6868
* freeTextSearch: true,

packages/drizzle/src/pg/operators.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -892,7 +892,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
892892
/**
893893
* Equality operator - encrypts value for encrypted columns.
894894
* Requires either `equality` or `orderAndRange` to be set on {@link EncryptedColumnConfig}.
895-
*
895+
*
896896
* @example
897897
* Select users with a specific email address.
898898
* ```ts
@@ -905,7 +905,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
905905
/**
906906
* Not equal operator - encrypts value for encrypted columns.
907907
* Requires either `equality` or `orderAndRange` to be set on {@link EncryptedColumnConfig}.
908-
*
908+
*
909909
* @example
910910
* Select users whose email address is not a specific value.
911911
* ```ts
@@ -918,7 +918,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
918918
/**
919919
* Greater than operator for encrypted columns with ORE index.
920920
* Requires `orderAndRange` to be set on {@link EncryptedColumnConfig}.
921-
*
921+
*
922922
* @example
923923
* Select users older than a specific age.
924924
* ```ts
@@ -931,7 +931,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
931931
/**
932932
* Greater than or equal operator for encrypted columns with ORE index.
933933
* Requires `orderAndRange` to be set on {@link EncryptedColumnConfig}.
934-
*
934+
*
935935
* @example
936936
* Select users older than or equal to a specific age.
937937
* ```ts
@@ -944,7 +944,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
944944
/**
945945
* Less than operator for encrypted columns with ORE index.
946946
* Requires `orderAndRange` to be set on {@link EncryptedColumnConfig}.
947-
*
947+
*
948948
* @example
949949
* Select users younger than a specific age.
950950
* ```ts
@@ -957,7 +957,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
957957
/**
958958
* Less than or equal operator for encrypted columns with ORE index.
959959
* Requires `orderAndRange` to be set on {@link EncryptedColumnConfig}.
960-
*
960+
*
961961
* @example
962962
* Select users younger than or equal to a specific age.
963963
* ```ts
@@ -966,11 +966,11 @@ export function createProtectOperators(protectClient: ProtectClient): {
966966
* ```
967967
*/
968968
lte: (left: SQLWrapper, right: unknown) => Promise<SQL> | SQL
969-
969+
970970
/**
971971
* Between operator for encrypted columns with ORE index.
972972
* Requires `orderAndRange` to be set on {@link EncryptedColumnConfig}.
973-
*
973+
*
974974
* @example
975975
* Select users within a specific age range.
976976
* ```ts
@@ -983,7 +983,7 @@ export function createProtectOperators(protectClient: ProtectClient): {
983983
/**
984984
* Not between operator for encrypted columns with ORE index.
985985
* Requires `orderAndRange` to be set on {@link EncryptedColumnConfig}.
986-
*
986+
*
987987
* @example
988988
* Select users outside a specific age range.
989989
* ```ts
@@ -1000,28 +1000,28 @@ export function createProtectOperators(protectClient: ProtectClient): {
10001000
/**
10011001
* Like operator for encrypted columns with free text search.
10021002
* Requires `freeTextSearch` to be set on {@link EncryptedColumnConfig}.
1003-
*
1003+
*
10041004
* > [!IMPORTANT]
10051005
* > Case sensitivity on encrypted columns depends on the {@link EncryptedColumnConfig}.
10061006
* > Ensure that the column is configured for case-insensitive search if needed.
1007-
*
1007+
*
10081008
* @example
10091009
* Select users with email addresses matching a pattern.
10101010
* ```ts
10111011
* const condition = await protectOps.like(usersTable.email, '%@example.com')
10121012
* const results = await db.select().from(usersTable).where(condition)
1013-
* ```
1013+
* ```
10141014
*/
10151015
like: (left: SQLWrapper, right: unknown) => Promise<SQL> | SQL
10161016

10171017
/**
10181018
* ILike operator for encrypted columns with free text search.
10191019
* Requires `freeTextSearch` to be set on {@link EncryptedColumnConfig}.
1020-
*
1020+
*
10211021
* > [!IMPORTANT]
10221022
* > Case sensitivity on encrypted columns depends on the {@link EncryptedColumnConfig}.
10231023
* > Ensure that the column is configured for case-insensitive search if needed.
1024-
*
1024+
*
10251025
* @example
10261026
* Select users with email addresses matching a pattern (case-insensitive).
10271027
* ```ts

packages/schema/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export const encryptConfigSchema = z.object({
9090
/**
9191
* Type-safe alias for {@link castAsEnum} used to specify the *unencrypted* data type of a column or value.
9292
* This is important because once encrypted, all data is stored as binary blobs.
93-
*
93+
*
9494
* @see {@link castAsEnum} for possible values.
9595
*/
9696
export type CastAs = z.infer<typeof castAsEnum>

0 commit comments

Comments
 (0)