From f4cb3339b7ce756b345381e36617917b5fd72e22 Mon Sep 17 00:00:00 2001 From: danstarns Date: Thu, 29 Aug 2024 20:33:17 -0700 Subject: [PATCH] refactor: change to onRecordSetValue --- docs/modules/DataSources.md | 4 ++-- src/data_sources/model/DataRecord.ts | 6 +++--- src/data_sources/types.ts | 2 +- test/specs/data_sources/transformers.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/modules/DataSources.md b/docs/modules/DataSources.md index 962358849..736244de1 100644 --- a/docs/modules/DataSources.md +++ b/docs/modules/DataSources.md @@ -154,7 +154,7 @@ const testDataSource = { In this example, every record added will have its `content` field converted to uppercase. -### 2. `onRecordSet` +### 2. `onRecordSetValue` This transformer is invoked when a record's property is updated. It provides an opportunity to validate or transform the new value. @@ -165,7 +165,7 @@ const testDataSource = { id: 'test-data-source', records: [], transformers: { - onRecordSet: ({ id, key, value }) => { + onRecordSetValue: ({ id, key, value }) => { if (key !== 'content') { return value; } diff --git a/src/data_sources/model/DataRecord.ts b/src/data_sources/model/DataRecord.ts index dd3cfe228..bf64dbfcf 100644 --- a/src/data_sources/model/DataRecord.ts +++ b/src/data_sources/model/DataRecord.ts @@ -137,13 +137,13 @@ export default class DataRecord ext options?: SetOptions | undefined, ): this; set(attributeName: unknown, value?: unknown, options?: SetOptions): DataRecord { - const onRecordSet = this.dataSource?.transformers?.onRecordSet; + const onRecordSetValue = this.dataSource?.transformers?.onRecordSetValue; const applySet = (key: string, val: unknown) => { const newValue = - options?.avoidTransformers || !onRecordSet + options?.avoidTransformers || !onRecordSetValue ? val - : onRecordSet({ + : onRecordSetValue({ id: this.id, key, value: val, diff --git a/src/data_sources/types.ts b/src/data_sources/types.ts index 037f055bc..1b769899f 100644 --- a/src/data_sources/types.ts +++ b/src/data_sources/types.ts @@ -34,7 +34,7 @@ export interface DataSourceProps { export interface DataSourceTransformers { onRecordAdd?: (args: { record: DataRecordProps }) => DataRecordProps; - onRecordSet?: (args: { id: string | number; key: string; value: any }) => any; + onRecordSetValue?: (args: { id: string | number; key: string; value: any }) => any; onRecordDelete?: (args: { record: DataRecord }) => void; onRecordRead?: (args: { record: DataRecord }) => DataRecord; } diff --git a/test/specs/data_sources/transformers.ts b/test/specs/data_sources/transformers.ts index 4a67ed0ff..df7b751f6 100644 --- a/test/specs/data_sources/transformers.ts +++ b/test/specs/data_sources/transformers.ts @@ -69,12 +69,12 @@ describe('DataSource Transformers', () => { expect(result).toBe('I LOVE GRAPES'); }); - test('onRecordSet', () => { + test('onRecordSetValue', () => { const testDataSource: DataSourceProps = { id: 'test-data-source', records: [], transformers: { - onRecordSet: ({ id, key, value }) => { + onRecordSetValue: ({ id, key, value }) => { if (key !== 'content') { return value; }