Skip to content

Pass adapterResult to column consume function #1121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: 21.x
Choose a base branch
from
Open

Pass adapterResult to column consume function #1121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73b3853
Pass adapterResult to column consume function
p3drosola Jul 16, 2025
4536718
Add test that covers all arguments passed to consume callback
p3drosola Jul 18, 2025
57df8fa
Formatting
p3drosola Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/orm/base_model/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1707,7 +1707,7 @@ class BaseModelImpl implements LucidRow {
*/
const value =
typeof attribute.consume === 'function'
? attribute.consume(adapterResult[key], attributeName, this)
? attribute.consume(adapterResult[key], attributeName, this, adapterResult)
: adapterResult[key]

/**
Expand Down
2 changes: 1 addition & 1 deletion src/types/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ export type ColumnOptions = {
/**
* Invoked when row is fetched from the database
*/
consume?: (value: any, attribute: string, model: LucidRow) => any
consume?: (value: any, attribute: string, model: LucidRow, adapterResult: ModelObject) => any
}

/**
Expand Down
15 changes: 11 additions & 4 deletions test/orm/base_model.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1817,18 +1817,25 @@ test.group('Base Model | create from adapter results', (group) => {
declare username: string

@column({
consume: (value) => value.toUpperCase(),
consume: (value, attribute, instance, adapterResult) =>
`${value.toUpperCase()} ${attribute} ${instance.constructor.name.toString()} ${adapterResult.username}`,
})
declare fullName: string
}

const user = User.$createFromAdapterResult({ full_name: 'virk' })
const user = User.$createFromAdapterResult({ full_name: 'Harminder Virk', username: 'virk' })

assert.isTrue(user!.$isPersisted)
assert.isFalse(user!.$isDirty)
assert.isFalse(user!.$isLocal)
assert.deepEqual(user!.$attributes, { fullName: 'VIRK' })
assert.deepEqual(user!.$original, { fullName: 'VIRK' })
assert.deepEqual(user!.$attributes, {
fullName: 'HARMINDER VIRK fullName User virk',
username: 'virk',
})
assert.deepEqual(user!.$original, {
fullName: 'HARMINDER VIRK fullName User virk',
username: 'virk',
})
})

test('original and attributes should not be shared', async ({ fs, assert }) => {
Expand Down