feat (client): make converter API public #1397
Conversation
kevin-dp
force-pushed
the
kevindp/vax-1931-extract-sync-and-raw
branch
2 times, most recently
from
b2f1f0f
to
f2f3bc7
Compare
kevin-dp
force-pushed
the
kevindp/vax-1965-expose-converter-API
branch
from
e614240
to
aac4863
Compare
| @@ -1,6 +1,6 @@ | |||
| elixir 1.17.0-otp-27 | |||
| erlang 27.0 | |||
| nodejs 20.2.0 | |||
| nodejs 21.4.0 | |||
There was a problem hiding this comment.
might need to update the CI workflows to use this version as well in the test matrix, build, etc
| @@ -26,3 +64,34 @@ export interface Converter { | |||
| export function isDataObject(v: unknown): boolean { | |||
| return v instanceof Date || typeof v === 'bigint' || ArrayBuffer.isView(v) | |||
| } | |||
|
|
|||
| export function mapRow< | |||
| T extends Record<string, unknown> = Record<string, unknown> | |||
There was a problem hiding this comment.
nit: might be worth extracting Record<string, unknown> to a type alias like RowRecord or something as it's so common
| >( | ||
| row: Record<string, unknown>, | ||
| tableSchema: Pick<AnyTableSchema, 'fields'>, | ||
| f: (v: any, pgType: PgType) => any |
There was a problem hiding this comment.
nit: more explicit name like convert? f feels a little bit too terse haha
| >( | ||
| rows: Array<Record<string, unknown>>, | ||
| tableSchema: Pick<AnyTableSchema, 'fields'>, | ||
| f: (v: any, pgType: PgType) => any |
| @@ -11,7 +12,7 @@ import { PgBasicType, PgDateType, PgType } from './types' | |||
| * Currently, no conversions are needed for the data types we support. | |||
| */ | |||
|
|
|||
| function toPostgres(v: any, pgType: PgType): any { | |||
| export function toPostgres(v: any, pgType: PgType): any { | |||
There was a problem hiding this comment.
nit: why are these exported, they are exported via the converter interface no? (same for SQLite)
| @@ -221,6 +225,10 @@ export class Table< | |||
| * As such, one can compose these methods arbitrarily and then run them inside a single transaction. | |||
| */ | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
nit: might need more rebasing? haha
|
👋 we've been working the last month on a rebuild of the Electric server over at a temporary repo https://github.com/electric-sql/electric-next/ You can read more about why we made the decision at https://next.electric-sql.com/about We're really excited about all the new possibilities the new server brings and we hope you'll check it out soon and give us your feedback. We're now moving the temporary repo back here. As part of that migration we're closing all the old issues and PRs. We really appreciate you taking the time to investigate and create this improvement! |
This PR extends the converter API with
encodeRow(s)/decodeRow(s)methods and exports the API.This API is a nice to have when dealing with raw queries and having to correctly serialise/deserialise rows to/from the database.