Update transformer types and documentation #235
Conversation
| column : {to?: fn, from?: fn}, // Transforms incoming or outgoing column names | ||
| value : {to?: fn, from?: fn}, // Transforms incoming or outgoing row values | ||
| row : {to?: fn, from?: fn}, // Transforms entire incoming or outgoing rows |
There was a problem hiding this comment.
@porsager wasn't sure of the best way to represent this. Please tweak if have a better idea.
iby
force-pushed
the
chore/transformer
branch
from
23fc7da to
74a5b2a
Compare
types/index.d.ts
Outdated
| /** Transforms incoming and outgoing row values. */ | ||
| value?: (value: any) => any | { from?: (value: any) => any, to?: (value: any) => any }; | ||
| /** Transforms entire incoming and outgoing rows. */ | ||
| row?: (row: postgres.Row) => any | { from?: (row: postgres.Row) => any, to?: (row: postgres.Row) => any }; |
There was a problem hiding this comment.
@porsager is this the right signature for to?
There was a problem hiding this comment.
I assumes from's output should be to's input and vice versa, then I would suggest { from?: (row: postgres.Row) => any, to?: (row: any) => postgres.Row }, but I'm not sure where row.to could be used...
Also, I guess ( ) are missing in the union? TS sees (row: postgres.Row) => (any | { from?: (row: postgres.Row) => any, to?: (row: any) => any })
| row?: (row: postgres.Row) => any | { from?: (row: postgres.Row) => any, to?: (row: postgres.Row) => any }; | |
| row?: ((row: postgres.Row) => any) | { from?: (row: postgres.Row) => any, to?: (row: any) => any }; |
There was a problem hiding this comment.
@Minigugus nicely spotted, thank you! Yes, I had the same feeling about the row. I updated my commit with your suggestions to avoid these micro-changes. Please feel free to review further.
iby
force-pushed
the
chore/transformer
branch
from
74a5b2a to
6da4d0f
Compare
|
@Minigugus is doing a big type update here #257, so closing this for now, but please comment on that PR if this fix is missing. |
Compliments #212.